@shopify/cli 3.64.1 → 3.65.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/cli-ruby/lib/project_types/extension/models/specification_handlers/theme_app_extension.rb +1 -1
- package/dist/assets/cli-ruby/lib/shopify_cli/theme/dev_server/proxy.rb +2 -3
- package/dist/{chunk-QNI6VLVR.js → chunk-27HGZPUX.js} +3 -3
- package/dist/{chunk-ZKWHKX2C.js → chunk-3REVOIEW.js} +7 -7
- package/dist/{chunk-ATGUMSCJ.js → chunk-4HAEQQTQ.js} +4 -4
- package/dist/{chunk-KUVX423E.js → chunk-5EAVIJTQ.js} +2 -2
- package/dist/{chunk-7TIDA343.js → chunk-5YD4FDOS.js} +3 -3
- package/dist/{chunk-ARCFCLME.js → chunk-6M65VRAT.js} +5 -5
- package/dist/{chunk-7W6SRTYP.js → chunk-A4NQWDPT.js} +3 -3
- package/dist/{chunk-FDLU3RD4.js → chunk-BLKDGMHM.js} +4 -4
- package/dist/{chunk-2DXCIFDK.js → chunk-CFFAWVDL.js} +2 -2
- package/dist/{chunk-WVY52EEZ.js → chunk-CZ3SHYYH.js} +5 -5
- package/dist/{chunk-QYT42J3T.js → chunk-DX2RXOQ5.js} +4 -4
- package/dist/{chunk-NLE3ZLU6.js → chunk-EID6L4PR.js} +14 -10
- package/dist/{chunk-JNUJZFQL.js → chunk-EKT2GUGH.js} +2 -2
- package/dist/{chunk-UXA5YROL.js → chunk-EU5ZOEUT.js} +2 -2
- package/dist/{chunk-XNCQBHNR.js → chunk-EZ5DG73H.js} +5 -5
- package/dist/{chunk-7PVTYKQI.js → chunk-F2Y7KYHZ.js} +7 -7
- package/dist/{chunk-H6AQTECB.js → chunk-GDARYUPU.js} +21 -7
- package/dist/{chunk-OXMHVKM3.js → chunk-H42RFZDD.js} +5 -5
- package/dist/{chunk-X3OUSYUQ.js → chunk-J7BYFGNJ.js} +4 -4
- package/dist/{chunk-ZVT2WZZF.js → chunk-M7WMYV4S.js} +2 -2
- package/dist/{chunk-V7NH4SZB.js → chunk-MODBIZ4R.js} +2 -2
- package/dist/{chunk-KZTALMEV.js → chunk-N2BXKOJG.js} +4 -4
- package/dist/{chunk-SSAUIEBT.js → chunk-PY33KMCK.js} +2 -2
- package/dist/{chunk-OVWFZSJT.js → chunk-PYMSCBPA.js} +2 -2
- package/dist/{chunk-UQQI7TQG.js → chunk-PZM45AUI.js} +3 -3
- package/dist/{chunk-B7RN7IRD.js → chunk-QNY4RVJ6.js} +6 -1
- package/dist/{chunk-B3D5VLUA.js → chunk-TDWX3KIR.js} +2 -2
- package/dist/{chunk-NO7MYZEO.js → chunk-UMWKJFTM.js} +2 -2
- package/dist/{chunk-ZRGD2HUL.js → chunk-VWALMO2Z.js} +3 -3
- package/dist/{chunk-DX43V2L4.js → chunk-WMECC32P.js} +4 -4
- package/dist/{chunk-6PJAGL2L.js → chunk-YDS7NZBQ.js} +5 -5
- package/dist/{chunk-S7A7BHNA.js → chunk-YVHV3H5H.js} +4 -4
- package/dist/{chunk-ZIGJPI5N.js → chunk-YXPGPWR2.js} +39 -11
- package/dist/{chunk-S3HWVIGJ.js → chunk-ZXJU6UP4.js} +10 -6
- package/dist/{chunk-63D4EGTO.js → chunk-ZZKUI3DP.js} +3 -3
- package/dist/cli/commands/auth/logout.js +12 -12
- package/dist/cli/commands/auth/logout.test.js +13 -13
- package/dist/cli/commands/debug/command-flags.js +11 -11
- package/dist/cli/commands/demo/catalog.js +12 -12
- package/dist/cli/commands/demo/generate-file.js +12 -12
- package/dist/cli/commands/demo/index.js +12 -12
- package/dist/cli/commands/demo/print-ai-prompt.js +12 -12
- package/dist/cli/commands/docs/generate.js +11 -11
- package/dist/cli/commands/docs/generate.test.js +11 -11
- package/dist/cli/commands/help.js +11 -11
- package/dist/cli/commands/kitchen-sink/async.js +12 -12
- package/dist/cli/commands/kitchen-sink/async.test.js +12 -12
- package/dist/cli/commands/kitchen-sink/index.js +14 -14
- package/dist/cli/commands/kitchen-sink/index.test.js +14 -14
- package/dist/cli/commands/kitchen-sink/prompts.js +12 -12
- package/dist/cli/commands/kitchen-sink/prompts.test.js +12 -12
- package/dist/cli/commands/kitchen-sink/static.js +12 -12
- package/dist/cli/commands/kitchen-sink/static.test.js +12 -12
- package/dist/cli/commands/search.js +12 -12
- package/dist/cli/commands/upgrade.js +11 -11
- package/dist/cli/commands/version.js +12 -12
- package/dist/cli/commands/version.test.js +12 -12
- package/dist/cli/services/commands/search.js +4 -4
- package/dist/cli/services/commands/search.test.js +4 -4
- package/dist/cli/services/commands/version.js +6 -6
- package/dist/cli/services/commands/version.test.js +7 -7
- package/dist/cli/services/demo.js +4 -4
- package/dist/cli/services/demo.test.js +4 -4
- package/dist/cli/services/kitchen-sink/async.js +4 -4
- package/dist/cli/services/kitchen-sink/prompts.js +4 -4
- package/dist/cli/services/kitchen-sink/static.js +4 -4
- package/dist/cli/services/upgrade.js +5 -5
- package/dist/cli/services/upgrade.test.js +7 -7
- package/dist/{constants-EVER32LA.js → constants-Y4XF72NG.js} +3 -3
- package/dist/{custom-oclif-loader-BQAFOUNG.js → custom-oclif-loader-JHNX2EGV.js} +4 -4
- package/dist/{error-handler-S56KHSGD.js → error-handler-4UJ6363X.js} +10 -10
- package/dist/hooks/postrun.js +8 -8
- package/dist/hooks/prerun.js +6 -6
- package/dist/index.js +4889 -2903
- package/dist/{local-UQAQKOVL.js → local-V7RONWNU.js} +4 -4
- package/dist/{node-GZYZUMBW.js → node-3H4OKRLA.js} +13 -13
- package/dist/{node-package-manager-AOVZD6TP.js → node-package-manager-XM7EXHQA.js} +5 -5
- package/dist/{path-KUSF6CYC.js → path-ZCRJKM4K.js} +4 -2
- package/dist/{system-G7DVECOP.js → system-F63VIZ5U.js} +4 -4
- package/dist/templates/ui-extensions/projects/web_pixel_extension/package.json.liquid +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/{ui-2AOZFYFM.js → ui-BXWWRIFS.js} +4 -4
- package/dist/{workerd-2MO23YDQ.js → workerd-A5NCF6UA.js} +13 -13
- package/oclif.manifest.json +150 -13
- package/package.json +6 -6
package/oclif.manifest.json
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
],
|
|
6
6
|
"args": {
|
|
7
7
|
},
|
|
8
|
+
"customPluginName": "@shopify/app",
|
|
8
9
|
"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\" (https://shopify.dev/docs/apps/tools/cli/configuration).\n\n If you're building a \"theme app extension\" (https://shopify.dev/docs/apps/online-store/theme-app-extensions), then running the `build` command runs \"Theme Check\" (https://shopify.dev/docs/themes/tools/theme-check) against your extension to ensure that it's valid.",
|
|
9
10
|
"descriptionWithMarkdown": "This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to [App configuration](https://shopify.dev/docs/apps/tools/cli/configuration).\n\n If you're building a [theme app extension](https://shopify.dev/docs/apps/online-store/theme-app-extensions), then running the `build` command runs [Theme Check](https://shopify.dev/docs/themes/tools/theme-check) against your extension to ensure that it's valid.",
|
|
10
11
|
"flags": {
|
|
@@ -91,6 +92,7 @@
|
|
|
91
92
|
],
|
|
92
93
|
"args": {
|
|
93
94
|
},
|
|
95
|
+
"customPluginName": "@shopify/app",
|
|
94
96
|
"description": "Pulls app configuration from the Partner 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\" (https://shopify.dev/docs/apps/tools/cli/configuration) page.\n ",
|
|
95
97
|
"descriptionWithMarkdown": "Pulls app configuration from the Partner 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](https://shopify.dev/docs/apps/tools/cli/configuration) page.\n ",
|
|
96
98
|
"flags": {
|
|
@@ -158,6 +160,7 @@
|
|
|
158
160
|
"name": "config"
|
|
159
161
|
}
|
|
160
162
|
},
|
|
163
|
+
"customPluginName": "@shopify/app",
|
|
161
164
|
"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.",
|
|
162
165
|
"descriptionWithMarkdown": "Sets default configuration when you run app-related CLI commands. If you omit the `config-name` parameter, then you'll be prompted to choose from the configuration files in your project.",
|
|
163
166
|
"flags": {
|
|
@@ -210,6 +213,7 @@
|
|
|
210
213
|
],
|
|
211
214
|
"args": {
|
|
212
215
|
},
|
|
216
|
+
"customPluginName": "@shopify/app",
|
|
213
217
|
"description": "\"Builds the app\" (https://shopify.dev/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, including the app extensions that you manage in the Partner Dashboard. This version is then released to users.\n\n This command doesn't deploy your \"web app\" (https://shopify.dev/docs/apps/tools/cli/structure#web-components). You need to \"deploy your web app\" (https://shopify.dev/docs/apps/deployment/web) to your own hosting solution.\n ",
|
|
214
218
|
"descriptionWithMarkdown": "[Builds the app](https://shopify.dev/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, including the app extensions that you manage in the Partner Dashboard. This version is then released to users.\n\n This command doesn't deploy your [web app](https://shopify.dev/docs/apps/tools/cli/structure#web-components). You need to [deploy your web app](https://shopify.dev/docs/apps/deployment/web) to your own hosting solution.\n ",
|
|
215
219
|
"flags": {
|
|
@@ -343,6 +347,7 @@
|
|
|
343
347
|
],
|
|
344
348
|
"args": {
|
|
345
349
|
},
|
|
350
|
+
"customPluginName": "@shopify/app",
|
|
346
351
|
"description": "\"Builds the app\" (https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a \"development store\" (https://shopify.dev/docs/apps/tools/development-stores) or \"Plus sandbox store\" (https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving \"GraphiQL for the Admin API\" (https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the PHP or Ruby app template, then you need to complete the following steps before you can preview your app for the first time:\n\n- PHP: \"Set up your Laravel app\" (https://github.com/Shopify/shopify-app-template-php#setting-up-your-laravel-app)\n- Ruby: \"Set up your Rails app\" (https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app)\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a \"staff account\" (https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
|
|
347
352
|
"descriptionWithMarkdown": "[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a [development store](https://shopify.dev/docs/apps/tools/development-stores) or [Plus sandbox store](https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving [GraphiQL for the Admin API](https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the PHP or Ruby app template, then you need to complete the following steps before you can preview your app for the first time:\n\n- PHP: [Set up your Laravel app](https://github.com/Shopify/shopify-app-template-php#setting-up-your-laravel-app)\n- Ruby: [Set up your Rails app](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app)\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a [staff account](https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
|
|
348
353
|
"flags": {
|
|
@@ -554,6 +559,7 @@
|
|
|
554
559
|
],
|
|
555
560
|
"args": {
|
|
556
561
|
},
|
|
562
|
+
"customPluginName": "@shopify/app",
|
|
557
563
|
"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.",
|
|
558
564
|
"descriptionWithMarkdown": "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.",
|
|
559
565
|
"flags": {
|
|
@@ -617,6 +623,7 @@
|
|
|
617
623
|
],
|
|
618
624
|
"args": {
|
|
619
625
|
},
|
|
626
|
+
"customPluginName": "@shopify/app",
|
|
620
627
|
"description": "Displays environment variables that can be used to deploy apps and app extensions.",
|
|
621
628
|
"descriptionWithMarkdown": "Displays environment variables that can be used to deploy apps and app extensions.",
|
|
622
629
|
"flags": {
|
|
@@ -671,6 +678,7 @@
|
|
|
671
678
|
],
|
|
672
679
|
"args": {
|
|
673
680
|
},
|
|
681
|
+
"customPluginName": "@shopify/app",
|
|
674
682
|
"description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
|
|
675
683
|
"descriptionWithMarkdown": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
|
|
676
684
|
"enableJsonFlag": false,
|
|
@@ -727,6 +735,7 @@
|
|
|
727
735
|
],
|
|
728
736
|
"args": {
|
|
729
737
|
},
|
|
738
|
+
"customPluginName": "@shopify/app",
|
|
730
739
|
"description": "Runs the function from your current directory for \"testing purposes\" (https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to \"Shopify Functions error handling\" (https://shopify.dev/docs/api/functions/errors).",
|
|
731
740
|
"descriptionWithMarkdown": "Runs the function from your current directory for [testing purposes](https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](https://shopify.dev/docs/api/functions/errors).",
|
|
732
741
|
"enableJsonFlag": false,
|
|
@@ -835,6 +844,7 @@
|
|
|
835
844
|
],
|
|
836
845
|
"args": {
|
|
837
846
|
},
|
|
847
|
+
"customPluginName": "@shopify/app",
|
|
838
848
|
"description": "Runs the function from your current directory for \"testing purposes\" (https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to \"Shopify Functions error handling\" (https://shopify.dev/docs/api/functions/errors).",
|
|
839
849
|
"descriptionWithMarkdown": "Runs the function from your current directory for [testing purposes](https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](https://shopify.dev/docs/api/functions/errors).",
|
|
840
850
|
"enableJsonFlag": false,
|
|
@@ -919,6 +929,7 @@
|
|
|
919
929
|
],
|
|
920
930
|
"args": {
|
|
921
931
|
},
|
|
932
|
+
"customPluginName": "@shopify/app",
|
|
922
933
|
"description": "Generates the latest \"GraphQL schema\" (https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.\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.",
|
|
923
934
|
"descriptionWithMarkdown": "Generates the latest [GraphQL schema](https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.\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.",
|
|
924
935
|
"enableJsonFlag": false,
|
|
@@ -1007,6 +1018,7 @@
|
|
|
1007
1018
|
],
|
|
1008
1019
|
"args": {
|
|
1009
1020
|
},
|
|
1021
|
+
"customPluginName": "@shopify/app",
|
|
1010
1022
|
"description": "Creates GraphQL types based on your \"input query\" (https://shopify.dev/docs/apps/functions/input-output#input) for a function written in JavaScript.",
|
|
1011
1023
|
"descriptionWithMarkdown": "Creates GraphQL types based on your [input query](https://shopify.dev/docs/apps/functions/input-output#input) for a function written in JavaScript.",
|
|
1012
1024
|
"enableJsonFlag": false,
|
|
@@ -1066,6 +1078,7 @@
|
|
|
1066
1078
|
"name": "file"
|
|
1067
1079
|
}
|
|
1068
1080
|
},
|
|
1081
|
+
"customPluginName": "@shopify/app",
|
|
1069
1082
|
"description": "Generates a new \"app extension\" (https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to \"Supported extensions\" (https://shopify.dev/docs/apps/structure/app-extensions/list).\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\" (https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ",
|
|
1070
1083
|
"descriptionWithMarkdown": "Generates a new [app extension](https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/structure/app-extensions/list).\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](https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ",
|
|
1071
1084
|
"examples": [
|
|
@@ -1215,6 +1228,7 @@
|
|
|
1215
1228
|
],
|
|
1216
1229
|
"args": {
|
|
1217
1230
|
},
|
|
1231
|
+
"customPluginName": "@shopify/app",
|
|
1218
1232
|
"description": "\"DEPRECATED, use `app function schema`] Generates the latest [GraphQL schema\" (https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.\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.",
|
|
1219
1233
|
"descriptionWithMarkdown": "[DEPRECATED, use `app function schema`] Generates the latest [GraphQL schema](https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.\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.",
|
|
1220
1234
|
"enableJsonFlag": false,
|
|
@@ -1304,6 +1318,7 @@
|
|
|
1304
1318
|
],
|
|
1305
1319
|
"args": {
|
|
1306
1320
|
},
|
|
1321
|
+
"customPluginName": "@shopify/app",
|
|
1307
1322
|
"description": "Import dashboard-managed extensions into your app.",
|
|
1308
1323
|
"flags": {
|
|
1309
1324
|
"client-id": {
|
|
@@ -1368,6 +1383,7 @@
|
|
|
1368
1383
|
],
|
|
1369
1384
|
"args": {
|
|
1370
1385
|
},
|
|
1386
|
+
"customPluginName": "@shopify/app",
|
|
1371
1387
|
"description": "The information returned includes the following:\n\n - The app and development store or Plus sandbox store that's used when you run the \"dev\" (https://shopify.dev/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using \"`dev --reset`\" (https://shopify.dev/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).\n - The \"structure\" (https://shopify.dev/docs/apps/tools/cli/structure) of your app project.\n - The \"access scopes\" (https://shopify.dev/docs/api/usage) your app has requested.\n - System information, including the package manager and version of Shopify CLI used in the project.",
|
|
1372
1388
|
"descriptionWithMarkdown": "The information returned includes the following:\n\n - The app and development store or Plus sandbox store that's used when you run the [dev](https://shopify.dev/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using [`dev --reset`](https://shopify.dev/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).\n - The [structure](https://shopify.dev/docs/apps/tools/cli/structure) of your app project.\n - The [access scopes](https://shopify.dev/docs/api/usage) your app has requested.\n - System information, including the package manager and version of Shopify CLI used in the project.",
|
|
1373
1389
|
"flags": {
|
|
@@ -1438,6 +1454,7 @@
|
|
|
1438
1454
|
],
|
|
1439
1455
|
"args": {
|
|
1440
1456
|
},
|
|
1457
|
+
"customPluginName": "@shopify/app",
|
|
1441
1458
|
"enableJsonFlag": false,
|
|
1442
1459
|
"flags": {
|
|
1443
1460
|
"flavor": {
|
|
@@ -1530,6 +1547,7 @@
|
|
|
1530
1547
|
],
|
|
1531
1548
|
"args": {
|
|
1532
1549
|
},
|
|
1550
|
+
"customPluginName": "@shopify/app",
|
|
1533
1551
|
"description": "\n Opens a real-time stream of detailed log events from the selected app and store.\n Use the `--source` argument to limit output to a particular function, such as a specific Shopify Function handle.\n Use the `--status` argument to specify the type of status to retrieve, either `success` or `failure`.\n ```\n shopify app logs --status=success --source=extension-handle\n ```\n ",
|
|
1534
1552
|
"descriptionWithMarkdown": "\n Opens a real-time stream of detailed log events from the selected app and store.\n Use the `--source` argument to limit output to a particular function, such as a specific Shopify Function handle.\n Use the `--status` argument to specify the type of status to retrieve, either `success` or `failure`.\n ```\n shopify app logs --status=success --source=extension-handle\n ```\n ",
|
|
1535
1553
|
"flags": {
|
|
@@ -1602,6 +1620,14 @@
|
|
|
1602
1620
|
"name": "graphiql-port",
|
|
1603
1621
|
"type": "option"
|
|
1604
1622
|
},
|
|
1623
|
+
"json": {
|
|
1624
|
+
"allowNo": false,
|
|
1625
|
+
"char": "j",
|
|
1626
|
+
"description": "Log the run result as a JSON object.",
|
|
1627
|
+
"env": "SHOPIFY_FLAG_JSON",
|
|
1628
|
+
"name": "json",
|
|
1629
|
+
"type": "boolean"
|
|
1630
|
+
},
|
|
1605
1631
|
"no-color": {
|
|
1606
1632
|
"allowNo": false,
|
|
1607
1633
|
"description": "Disable color output.",
|
|
@@ -1762,6 +1788,7 @@
|
|
|
1762
1788
|
],
|
|
1763
1789
|
"args": {
|
|
1764
1790
|
},
|
|
1791
|
+
"customPluginName": "@shopify/app",
|
|
1765
1792
|
"description": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.",
|
|
1766
1793
|
"descriptionWithMarkdown": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.",
|
|
1767
1794
|
"flags": {
|
|
@@ -1871,6 +1898,7 @@
|
|
|
1871
1898
|
"name": "file"
|
|
1872
1899
|
}
|
|
1873
1900
|
},
|
|
1901
|
+
"customPluginName": "@shopify/app",
|
|
1874
1902
|
"description": "Lists the deployed app versions. An app version is a snapshot of your app extensions.",
|
|
1875
1903
|
"descriptionWithMarkdown": "Lists the deployed app versions. An app version is a snapshot of your app extensions.",
|
|
1876
1904
|
"examples": [
|
|
@@ -1959,6 +1987,7 @@
|
|
|
1959
1987
|
],
|
|
1960
1988
|
"args": {
|
|
1961
1989
|
},
|
|
1990
|
+
"customPluginName": "@shopify/app",
|
|
1962
1991
|
"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\" (https://shopify.dev/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\" (https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ",
|
|
1963
1992
|
"descriptionWithMarkdown": "\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](https://shopify.dev/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](https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ",
|
|
1964
1993
|
"enableJsonFlag": false,
|
|
@@ -2102,6 +2131,7 @@
|
|
|
2102
2131
|
],
|
|
2103
2132
|
"args": {
|
|
2104
2133
|
},
|
|
2134
|
+
"customPluginName": "@oclif/plugin-commands",
|
|
2105
2135
|
"description": "list all the commands",
|
|
2106
2136
|
"enableJsonFlag": true,
|
|
2107
2137
|
"flags": {
|
|
@@ -2229,6 +2259,7 @@
|
|
|
2229
2259
|
],
|
|
2230
2260
|
"args": {
|
|
2231
2261
|
},
|
|
2262
|
+
"customPluginName": "@shopify/plugin-did-you-mean",
|
|
2232
2263
|
"description": "Disable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
|
|
2233
2264
|
"descriptionWithMarkdown": "Disable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
|
|
2234
2265
|
"enableJsonFlag": false,
|
|
@@ -2249,6 +2280,7 @@
|
|
|
2249
2280
|
],
|
|
2250
2281
|
"args": {
|
|
2251
2282
|
},
|
|
2283
|
+
"customPluginName": "@shopify/plugin-did-you-mean",
|
|
2252
2284
|
"description": "Enable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
|
|
2253
2285
|
"descriptionWithMarkdown": "Enable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
|
|
2254
2286
|
"enableJsonFlag": false,
|
|
@@ -2269,6 +2301,7 @@
|
|
|
2269
2301
|
],
|
|
2270
2302
|
"args": {
|
|
2271
2303
|
},
|
|
2304
|
+
"customPluginName": "@shopify/plugin-did-you-mean",
|
|
2272
2305
|
"description": "Check whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
|
|
2273
2306
|
"descriptionWithMarkdown": "Check whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
|
|
2274
2307
|
"enableJsonFlag": false,
|
|
@@ -2427,6 +2460,60 @@
|
|
|
2427
2460
|
"pluginType": "core",
|
|
2428
2461
|
"strict": true
|
|
2429
2462
|
},
|
|
2463
|
+
"demo:watcher": {
|
|
2464
|
+
"aliases": [
|
|
2465
|
+
],
|
|
2466
|
+
"args": {
|
|
2467
|
+
},
|
|
2468
|
+
"customPluginName": "@shopify/app",
|
|
2469
|
+
"flags": {
|
|
2470
|
+
"config": {
|
|
2471
|
+
"char": "c",
|
|
2472
|
+
"description": "The name of the app configuration.",
|
|
2473
|
+
"env": "SHOPIFY_FLAG_APP_CONFIG",
|
|
2474
|
+
"hasDynamicHelp": false,
|
|
2475
|
+
"hidden": false,
|
|
2476
|
+
"multiple": false,
|
|
2477
|
+
"name": "config",
|
|
2478
|
+
"type": "option"
|
|
2479
|
+
},
|
|
2480
|
+
"no-color": {
|
|
2481
|
+
"allowNo": false,
|
|
2482
|
+
"description": "Disable color output.",
|
|
2483
|
+
"env": "SHOPIFY_FLAG_NO_COLOR",
|
|
2484
|
+
"hidden": false,
|
|
2485
|
+
"name": "no-color",
|
|
2486
|
+
"type": "boolean"
|
|
2487
|
+
},
|
|
2488
|
+
"path": {
|
|
2489
|
+
"description": "The path to your app directory.",
|
|
2490
|
+
"env": "SHOPIFY_FLAG_PATH",
|
|
2491
|
+
"hasDynamicHelp": false,
|
|
2492
|
+
"multiple": false,
|
|
2493
|
+
"name": "path",
|
|
2494
|
+
"noCacheDefault": true,
|
|
2495
|
+
"type": "option"
|
|
2496
|
+
},
|
|
2497
|
+
"verbose": {
|
|
2498
|
+
"allowNo": false,
|
|
2499
|
+
"description": "Increase the verbosity of the output.",
|
|
2500
|
+
"env": "SHOPIFY_FLAG_VERBOSE",
|
|
2501
|
+
"hidden": false,
|
|
2502
|
+
"name": "verbose",
|
|
2503
|
+
"type": "boolean"
|
|
2504
|
+
}
|
|
2505
|
+
},
|
|
2506
|
+
"hasDynamicHelp": false,
|
|
2507
|
+
"hidden": true,
|
|
2508
|
+
"hiddenAliases": [
|
|
2509
|
+
],
|
|
2510
|
+
"id": "demo:watcher",
|
|
2511
|
+
"pluginAlias": "@shopify/cli",
|
|
2512
|
+
"pluginName": "@shopify/cli",
|
|
2513
|
+
"pluginType": "core",
|
|
2514
|
+
"strict": true,
|
|
2515
|
+
"summary": "Watch and prints out changes to an app."
|
|
2516
|
+
},
|
|
2430
2517
|
"docs:generate": {
|
|
2431
2518
|
"aliases": [
|
|
2432
2519
|
],
|
|
@@ -2482,6 +2569,7 @@
|
|
|
2482
2569
|
],
|
|
2483
2570
|
"args": {
|
|
2484
2571
|
},
|
|
2572
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2485
2573
|
"description": "Builds a Hydrogen storefront for production.",
|
|
2486
2574
|
"descriptionWithMarkdown": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.",
|
|
2487
2575
|
"enableJsonFlag": false,
|
|
@@ -2585,6 +2673,7 @@
|
|
|
2585
2673
|
"required": true
|
|
2586
2674
|
}
|
|
2587
2675
|
},
|
|
2676
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2588
2677
|
"description": "Returns diagnostic information about a Hydrogen storefront.",
|
|
2589
2678
|
"descriptionWithMarkdown": "Checks whether your Hydrogen app includes a set of standard Shopify routes.",
|
|
2590
2679
|
"enableJsonFlag": false,
|
|
@@ -2612,6 +2701,7 @@
|
|
|
2612
2701
|
],
|
|
2613
2702
|
"args": {
|
|
2614
2703
|
},
|
|
2704
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2615
2705
|
"description": "Generate types for the Storefront API queries found in your project.",
|
|
2616
2706
|
"descriptionWithMarkdown": "Automatically generates GraphQL types for your project’s Storefront API queries.",
|
|
2617
2707
|
"enableJsonFlag": false,
|
|
@@ -2662,6 +2752,7 @@
|
|
|
2662
2752
|
],
|
|
2663
2753
|
"args": {
|
|
2664
2754
|
},
|
|
2755
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2665
2756
|
"description": "Push project configuration to admin",
|
|
2666
2757
|
"enableJsonFlag": false,
|
|
2667
2758
|
"flags": {
|
|
@@ -2717,6 +2808,7 @@
|
|
|
2717
2808
|
],
|
|
2718
2809
|
"args": {
|
|
2719
2810
|
},
|
|
2811
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2720
2812
|
"description": "Builds and profiles the server startup time the app.",
|
|
2721
2813
|
"descriptionWithMarkdown": "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](https://shopify.dev/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).",
|
|
2722
2814
|
"enableJsonFlag": false,
|
|
@@ -2769,6 +2861,7 @@
|
|
|
2769
2861
|
],
|
|
2770
2862
|
"args": {
|
|
2771
2863
|
},
|
|
2864
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2772
2865
|
"description": "Builds and deploys a Hydrogen storefront to Oxygen.",
|
|
2773
2866
|
"descriptionWithMarkdown": "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](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.",
|
|
2774
2867
|
"enableJsonFlag": false,
|
|
@@ -2962,6 +3055,7 @@
|
|
|
2962
3055
|
],
|
|
2963
3056
|
"args": {
|
|
2964
3057
|
},
|
|
3058
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
2965
3059
|
"description": "Runs Hydrogen storefront in an Oxygen worker for development.",
|
|
2966
3060
|
"descriptionWithMarkdown": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n If your project is [linked](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.",
|
|
2967
3061
|
"enableJsonFlag": false,
|
|
@@ -3133,6 +3227,7 @@
|
|
|
3133
3227
|
],
|
|
3134
3228
|
"args": {
|
|
3135
3229
|
},
|
|
3230
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3136
3231
|
"description": "List the environments on your linked Hydrogen storefront.",
|
|
3137
3232
|
"descriptionWithMarkdown": "Lists all environments available on the linked Hydrogen storefront.",
|
|
3138
3233
|
"enableJsonFlag": false,
|
|
@@ -3160,6 +3255,7 @@
|
|
|
3160
3255
|
],
|
|
3161
3256
|
"args": {
|
|
3162
3257
|
},
|
|
3258
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3163
3259
|
"description": "Populate your .env with variables from your Hydrogen storefront.",
|
|
3164
3260
|
"descriptionWithMarkdown": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.",
|
|
3165
3261
|
"enableJsonFlag": false,
|
|
@@ -3217,6 +3313,7 @@
|
|
|
3217
3313
|
],
|
|
3218
3314
|
"args": {
|
|
3219
3315
|
},
|
|
3316
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3220
3317
|
"description": "Push environment variables from the local .env file to your linked Hydrogen storefront.",
|
|
3221
3318
|
"enableJsonFlag": false,
|
|
3222
3319
|
"flags": {
|
|
@@ -3260,6 +3357,7 @@
|
|
|
3260
3357
|
],
|
|
3261
3358
|
"args": {
|
|
3262
3359
|
},
|
|
3360
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3263
3361
|
"description": "Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.",
|
|
3264
3362
|
"enableJsonFlag": false,
|
|
3265
3363
|
"flags": {
|
|
@@ -3298,6 +3396,7 @@
|
|
|
3298
3396
|
"required": true
|
|
3299
3397
|
}
|
|
3300
3398
|
},
|
|
3399
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3301
3400
|
"description": "Generates a standard Shopify route.",
|
|
3302
3401
|
"descriptionWithMarkdown": "Generates a set of default routes from the starter template.",
|
|
3303
3402
|
"enableJsonFlag": false,
|
|
@@ -3356,6 +3455,7 @@
|
|
|
3356
3455
|
],
|
|
3357
3456
|
"args": {
|
|
3358
3457
|
},
|
|
3458
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3359
3459
|
"description": "Generates all supported standard shopify routes.",
|
|
3360
3460
|
"enableJsonFlag": false,
|
|
3361
3461
|
"flags": {
|
|
@@ -3413,6 +3513,7 @@
|
|
|
3413
3513
|
],
|
|
3414
3514
|
"args": {
|
|
3415
3515
|
},
|
|
3516
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3416
3517
|
"description": "Creates a new Hydrogen storefront.",
|
|
3417
3518
|
"descriptionWithMarkdown": "Creates a new Hydrogen storefront.",
|
|
3418
3519
|
"enableJsonFlag": false,
|
|
@@ -3536,6 +3637,7 @@
|
|
|
3536
3637
|
],
|
|
3537
3638
|
"args": {
|
|
3538
3639
|
},
|
|
3640
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3539
3641
|
"description": "Link a local project to one of your shop's Hydrogen storefronts.",
|
|
3540
3642
|
"descriptionWithMarkdown": "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](https://shopify.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](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.",
|
|
3541
3643
|
"enableJsonFlag": false,
|
|
@@ -3579,6 +3681,7 @@
|
|
|
3579
3681
|
],
|
|
3580
3682
|
"args": {
|
|
3581
3683
|
},
|
|
3684
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3582
3685
|
"description": "Returns a list of Hydrogen storefronts available on a given shop.",
|
|
3583
3686
|
"descriptionWithMarkdown": "Lists all remote Hydrogen storefronts available to link to your local development environment.",
|
|
3584
3687
|
"enableJsonFlag": false,
|
|
@@ -3606,6 +3709,7 @@
|
|
|
3606
3709
|
],
|
|
3607
3710
|
"args": {
|
|
3608
3711
|
},
|
|
3712
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3609
3713
|
"description": "Login to your Shopify account.",
|
|
3610
3714
|
"descriptionWithMarkdown": "Logs in to the specified shop and saves the shop domain to the project.",
|
|
3611
3715
|
"enableJsonFlag": false,
|
|
@@ -3642,6 +3746,7 @@
|
|
|
3642
3746
|
],
|
|
3643
3747
|
"args": {
|
|
3644
3748
|
},
|
|
3749
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3645
3750
|
"description": "Logout of your local session.",
|
|
3646
3751
|
"descriptionWithMarkdown": "Log out from the current shop.",
|
|
3647
3752
|
"enableJsonFlag": false,
|
|
@@ -3669,6 +3774,7 @@
|
|
|
3669
3774
|
],
|
|
3670
3775
|
"args": {
|
|
3671
3776
|
},
|
|
3777
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3672
3778
|
"description": "Runs a Hydrogen storefront in an Oxygen worker for production.",
|
|
3673
3779
|
"descriptionWithMarkdown": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.",
|
|
3674
3780
|
"enableJsonFlag": false,
|
|
@@ -3819,6 +3925,7 @@
|
|
|
3819
3925
|
],
|
|
3820
3926
|
"args": {
|
|
3821
3927
|
},
|
|
3928
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3822
3929
|
"description": "Scaffold routes and core functionality.",
|
|
3823
3930
|
"enableJsonFlag": false,
|
|
3824
3931
|
"flags": {
|
|
@@ -3885,6 +3992,7 @@
|
|
|
3885
3992
|
]
|
|
3886
3993
|
}
|
|
3887
3994
|
},
|
|
3995
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3888
3996
|
"description": "Setup CSS strategies for your project.",
|
|
3889
3997
|
"descriptionWithMarkdown": "Adds support for certain CSS strategies to your project.",
|
|
3890
3998
|
"enableJsonFlag": false,
|
|
@@ -3936,6 +4044,7 @@
|
|
|
3936
4044
|
]
|
|
3937
4045
|
}
|
|
3938
4046
|
},
|
|
4047
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3939
4048
|
"description": "Setup support for multiple markets in your project.",
|
|
3940
4049
|
"descriptionWithMarkdown": "Adds support for multiple [markets](https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.",
|
|
3941
4050
|
"enableJsonFlag": false,
|
|
@@ -3963,6 +4072,7 @@
|
|
|
3963
4072
|
],
|
|
3964
4073
|
"args": {
|
|
3965
4074
|
},
|
|
4075
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3966
4076
|
"description": "EXPERIMENTAL: Upgrades the project to use Vite.",
|
|
3967
4077
|
"enableJsonFlag": false,
|
|
3968
4078
|
"flags": {
|
|
@@ -3989,6 +4099,7 @@
|
|
|
3989
4099
|
],
|
|
3990
4100
|
"args": {
|
|
3991
4101
|
},
|
|
4102
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
3992
4103
|
"description": "Creates a global `h2` shortcut for the Hydrogen CLI",
|
|
3993
4104
|
"descriptionWithMarkdown": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n The following shells are supported:\n\n - Bash (using `~/.bashrc`)\n - ZSH (using `~/.zshrc`)\n - Fish (using `~/.config/fish/functions`)\n - PowerShell (added to `$PROFILE`)\n\n After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 <command>`.",
|
|
3994
4105
|
"enableJsonFlag": false,
|
|
@@ -4008,6 +4119,7 @@
|
|
|
4008
4119
|
],
|
|
4009
4120
|
"args": {
|
|
4010
4121
|
},
|
|
4122
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
4011
4123
|
"description": "Unlink a local project from a Hydrogen storefront.",
|
|
4012
4124
|
"descriptionWithMarkdown": "Unlinks your local development environment from a remote Hydrogen storefront.",
|
|
4013
4125
|
"enableJsonFlag": false,
|
|
@@ -4035,6 +4147,7 @@
|
|
|
4035
4147
|
],
|
|
4036
4148
|
"args": {
|
|
4037
4149
|
},
|
|
4150
|
+
"customPluginName": "@shopify/cli-hydrogen",
|
|
4038
4151
|
"description": "Upgrade Remix and Hydrogen npm dependencies.",
|
|
4039
4152
|
"descriptionWithMarkdown": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.",
|
|
4040
4153
|
"enableJsonFlag": false,
|
|
@@ -4156,6 +4269,7 @@
|
|
|
4156
4269
|
],
|
|
4157
4270
|
"args": {
|
|
4158
4271
|
},
|
|
4272
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4159
4273
|
"description": "List installed plugins.",
|
|
4160
4274
|
"enableJsonFlag": true,
|
|
4161
4275
|
"examples": [
|
|
@@ -4197,6 +4311,7 @@
|
|
|
4197
4311
|
"required": true
|
|
4198
4312
|
}
|
|
4199
4313
|
},
|
|
4314
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4200
4315
|
"description": "Displays installation properties of a plugin.",
|
|
4201
4316
|
"enableJsonFlag": true,
|
|
4202
4317
|
"examples": [
|
|
@@ -4245,6 +4360,7 @@
|
|
|
4245
4360
|
"required": true
|
|
4246
4361
|
}
|
|
4247
4362
|
},
|
|
4363
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4248
4364
|
"description": "",
|
|
4249
4365
|
"enableJsonFlag": true,
|
|
4250
4366
|
"examples": [
|
|
@@ -4331,6 +4447,7 @@
|
|
|
4331
4447
|
"required": true
|
|
4332
4448
|
}
|
|
4333
4449
|
},
|
|
4450
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4334
4451
|
"description": "Links a plugin into the CLI for development.\nInstallation of a linked plugin will override a user-installed or core plugin.\n\ne.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.\n",
|
|
4335
4452
|
"enableJsonFlag": false,
|
|
4336
4453
|
"examples": [
|
|
@@ -4371,6 +4488,7 @@
|
|
|
4371
4488
|
],
|
|
4372
4489
|
"args": {
|
|
4373
4490
|
},
|
|
4491
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4374
4492
|
"enableJsonFlag": false,
|
|
4375
4493
|
"flags": {
|
|
4376
4494
|
"hard": {
|
|
@@ -4407,6 +4525,7 @@
|
|
|
4407
4525
|
"name": "plugin"
|
|
4408
4526
|
}
|
|
4409
4527
|
},
|
|
4528
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4410
4529
|
"description": "Removes a plugin from the CLI.",
|
|
4411
4530
|
"enableJsonFlag": false,
|
|
4412
4531
|
"examples": [
|
|
@@ -4441,6 +4560,7 @@
|
|
|
4441
4560
|
],
|
|
4442
4561
|
"args": {
|
|
4443
4562
|
},
|
|
4563
|
+
"customPluginName": "@oclif/plugin-plugins",
|
|
4444
4564
|
"description": "Update installed plugins.",
|
|
4445
4565
|
"enableJsonFlag": false,
|
|
4446
4566
|
"flags": {
|
|
@@ -4496,6 +4616,7 @@
|
|
|
4496
4616
|
],
|
|
4497
4617
|
"args": {
|
|
4498
4618
|
},
|
|
4619
|
+
"customPluginName": "@shopify/theme",
|
|
4499
4620
|
"description": "Calls and runs \"Theme Check\" (https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. \"Learn more about the checks that Theme Check runs.\" (https://shopify.dev/docs/themes/tools/theme-check/checks)",
|
|
4500
4621
|
"descriptionWithMarkdown": "Calls and runs [Theme Check](https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. [Learn more about the checks that Theme Check runs.](https://shopify.dev/docs/themes/tools/theme-check/checks)",
|
|
4501
4622
|
"flags": {
|
|
@@ -4634,6 +4755,7 @@
|
|
|
4634
4755
|
],
|
|
4635
4756
|
"args": {
|
|
4636
4757
|
},
|
|
4758
|
+
"customPluginName": "@shopify/theme",
|
|
4637
4759
|
"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",
|
|
4638
4760
|
"descriptionWithMarkdown": "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",
|
|
4639
4761
|
"flags": {
|
|
@@ -4673,7 +4795,7 @@
|
|
|
4673
4795
|
},
|
|
4674
4796
|
"store": {
|
|
4675
4797
|
"char": "s",
|
|
4676
|
-
"description": "Store URL. It can be the store prefix (
|
|
4798
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
4677
4799
|
"env": "SHOPIFY_FLAG_STORE",
|
|
4678
4800
|
"hasDynamicHelp": false,
|
|
4679
4801
|
"multiple": false,
|
|
@@ -4717,6 +4839,7 @@
|
|
|
4717
4839
|
],
|
|
4718
4840
|
"args": {
|
|
4719
4841
|
},
|
|
4842
|
+
"customPluginName": "@shopify/theme",
|
|
4720
4843
|
"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.",
|
|
4721
4844
|
"descriptionWithMarkdown": "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.",
|
|
4722
4845
|
"flags": {
|
|
@@ -4771,7 +4894,7 @@
|
|
|
4771
4894
|
},
|
|
4772
4895
|
"store": {
|
|
4773
4896
|
"char": "s",
|
|
4774
|
-
"description": "Store URL. It can be the store prefix (
|
|
4897
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
4775
4898
|
"env": "SHOPIFY_FLAG_STORE",
|
|
4776
4899
|
"hasDynamicHelp": false,
|
|
4777
4900
|
"multiple": false,
|
|
@@ -4826,6 +4949,7 @@
|
|
|
4826
4949
|
"force",
|
|
4827
4950
|
"notify"
|
|
4828
4951
|
],
|
|
4952
|
+
"customPluginName": "@shopify/theme",
|
|
4829
4953
|
"description": "\n Uploads the current theme as the specified theme, or a \"development theme\" (https://shopify.dev/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\" (https://shopify.dev/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\" (https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or \"push\" (https://shopify.dev/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\" (https://shopify.dev/docs/themes/tools/cli#directory-structure).",
|
|
4830
4954
|
"descriptionWithMarkdown": "\n Uploads the current theme as the specified theme, or a [development theme](https://shopify.dev/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](https://shopify.dev/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](https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or [push](https://shopify.dev/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](https://shopify.dev/docs/themes/tools/cli#directory-structure).",
|
|
4831
4955
|
"flags": {
|
|
@@ -4968,7 +5092,7 @@
|
|
|
4968
5092
|
},
|
|
4969
5093
|
"store": {
|
|
4970
5094
|
"char": "s",
|
|
4971
|
-
"description": "Store URL. It can be the store prefix (
|
|
5095
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
4972
5096
|
"env": "SHOPIFY_FLAG_STORE",
|
|
4973
5097
|
"hasDynamicHelp": false,
|
|
4974
5098
|
"multiple": false,
|
|
@@ -5015,6 +5139,7 @@
|
|
|
5015
5139
|
],
|
|
5016
5140
|
"args": {
|
|
5017
5141
|
},
|
|
5142
|
+
"customPluginName": "@shopify/theme",
|
|
5018
5143
|
"description": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.",
|
|
5019
5144
|
"flags": {
|
|
5020
5145
|
"development": {
|
|
@@ -5059,7 +5184,7 @@
|
|
|
5059
5184
|
},
|
|
5060
5185
|
"store": {
|
|
5061
5186
|
"char": "s",
|
|
5062
|
-
"description": "Store URL. It can be the store prefix (
|
|
5187
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5063
5188
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5064
5189
|
"hasDynamicHelp": false,
|
|
5065
5190
|
"multiple": false,
|
|
@@ -5103,6 +5228,7 @@
|
|
|
5103
5228
|
"required": false
|
|
5104
5229
|
}
|
|
5105
5230
|
},
|
|
5231
|
+
"customPluginName": "@shopify/theme",
|
|
5106
5232
|
"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 \"Dawn\" (https://github.com/Shopify/dawn), Shopify's example theme, 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 Dawn as a starting point. However, the theme that you submit needs to be \"substantively different from Dawn\" (https://shopify.dev/docs/themes/store/requirements#uniqueness) so that it provides added value for users. Learn about the \"ways that you can use Dawn\" (https://shopify.dev/docs/themes/tools/dawn#ways-to-use-dawn).\n ",
|
|
5107
5233
|
"descriptionWithMarkdown": "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 [Dawn](https://github.com/Shopify/dawn), Shopify's example theme, 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 Dawn as a starting point. However, the theme that you submit needs to be [substantively different from Dawn](https://shopify.dev/docs/themes/store/requirements#uniqueness) so that it provides added value for users. Learn about the [ways that you can use Dawn](https://shopify.dev/docs/themes/tools/dawn#ways-to-use-dawn).\n ",
|
|
5108
5234
|
"flags": {
|
|
@@ -5166,6 +5292,7 @@
|
|
|
5166
5292
|
],
|
|
5167
5293
|
"args": {
|
|
5168
5294
|
},
|
|
5295
|
+
"customPluginName": "@shopify/theme",
|
|
5169
5296
|
"description": "Starts the \"Language Server\" (https://shopify.dev/docs/themes/tools/cli/language-server).",
|
|
5170
5297
|
"descriptionWithMarkdown": "Starts the [Language Server](https://shopify.dev/docs/themes/tools/cli/language-server).",
|
|
5171
5298
|
"flags": {
|
|
@@ -5201,6 +5328,7 @@
|
|
|
5201
5328
|
],
|
|
5202
5329
|
"args": {
|
|
5203
5330
|
},
|
|
5331
|
+
"customPluginName": "@shopify/theme",
|
|
5204
5332
|
"description": "Lists the themes in your store, along with their IDs and statuses.",
|
|
5205
5333
|
"flags": {
|
|
5206
5334
|
"environment": {
|
|
@@ -5266,7 +5394,7 @@
|
|
|
5266
5394
|
},
|
|
5267
5395
|
"store": {
|
|
5268
5396
|
"char": "s",
|
|
5269
|
-
"description": "Store URL. It can be the store prefix (
|
|
5397
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5270
5398
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5271
5399
|
"hasDynamicHelp": false,
|
|
5272
5400
|
"multiple": false,
|
|
@@ -5296,6 +5424,7 @@
|
|
|
5296
5424
|
],
|
|
5297
5425
|
"args": {
|
|
5298
5426
|
},
|
|
5427
|
+
"customPluginName": "@shopify/theme",
|
|
5299
5428
|
"description": "Returns links that let you preview the specified theme. The following links are returned:\n\n - A link to the \"editor\" (https://shopify.dev/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.",
|
|
5300
5429
|
"descriptionWithMarkdown": "Returns links that let you preview the specified theme. The following links are returned:\n\n - A link to the [editor](https://shopify.dev/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.",
|
|
5301
5430
|
"flags": {
|
|
@@ -5350,7 +5479,7 @@
|
|
|
5350
5479
|
},
|
|
5351
5480
|
"store": {
|
|
5352
5481
|
"char": "s",
|
|
5353
|
-
"description": "Store URL. It can be the store prefix (
|
|
5482
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5354
5483
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5355
5484
|
"hasDynamicHelp": false,
|
|
5356
5485
|
"multiple": false,
|
|
@@ -5390,6 +5519,7 @@
|
|
|
5390
5519
|
],
|
|
5391
5520
|
"args": {
|
|
5392
5521
|
},
|
|
5522
|
+
"customPluginName": "@shopify/theme",
|
|
5393
5523
|
"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\" (https://shopify.dev/docs/themes/tools/cli#directory-structure) are included in the package.\n\n The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your \"settings_schema.json\" (https://shopify.dev/docs/themes/architecture/config/settings-schema-json) file.",
|
|
5394
5524
|
"descriptionWithMarkdown": "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](https://shopify.dev/docs/themes/tools/cli#directory-structure) are included in the package.\n\n The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your [settings_schema.json](https://shopify.dev/docs/themes/architecture/config/settings-schema-json) file.",
|
|
5395
5525
|
"flags": {
|
|
@@ -5434,6 +5564,7 @@
|
|
|
5434
5564
|
],
|
|
5435
5565
|
"args": {
|
|
5436
5566
|
},
|
|
5567
|
+
"customPluginName": "@shopify/theme",
|
|
5437
5568
|
"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\" (https://shopify.dev/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.",
|
|
5438
5569
|
"descriptionWithMarkdown": "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](https://shopify.dev/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.",
|
|
5439
5570
|
"flags": {
|
|
@@ -5472,7 +5603,7 @@
|
|
|
5472
5603
|
},
|
|
5473
5604
|
"store": {
|
|
5474
5605
|
"char": "s",
|
|
5475
|
-
"description": "Store URL. It can be the store prefix (
|
|
5606
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5476
5607
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5477
5608
|
"hasDynamicHelp": false,
|
|
5478
5609
|
"multiple": false,
|
|
@@ -5522,6 +5653,7 @@
|
|
|
5522
5653
|
"force",
|
|
5523
5654
|
"development-theme-id"
|
|
5524
5655
|
],
|
|
5656
|
+
"customPluginName": "@shopify/theme",
|
|
5525
5657
|
"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.",
|
|
5526
5658
|
"descriptionWithMarkdown": "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.",
|
|
5527
5659
|
"flags": {
|
|
@@ -5628,7 +5760,7 @@
|
|
|
5628
5760
|
},
|
|
5629
5761
|
"store": {
|
|
5630
5762
|
"char": "s",
|
|
5631
|
-
"description": "Store URL. It can be the store prefix (
|
|
5763
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5632
5764
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5633
5765
|
"hasDynamicHelp": false,
|
|
5634
5766
|
"multiple": false,
|
|
@@ -5683,6 +5815,7 @@
|
|
|
5683
5815
|
"force",
|
|
5684
5816
|
"development-theme-id"
|
|
5685
5817
|
],
|
|
5818
|
+
"customPluginName": "@shopify/theme",
|
|
5686
5819
|
"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\" (https://shopify.dev/docs/themes/tools/cli#directory-structure).\n\n This command returns the following information:\n\n - A link to the \"editor\" (https://shopify.dev/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 ",
|
|
5687
5820
|
"descriptionWithMarkdown": "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](https://shopify.dev/docs/themes/tools/cli#directory-structure).\n\n This command returns the following information:\n\n - A link to the [editor](https://shopify.dev/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 ",
|
|
5688
5821
|
"flags": {
|
|
@@ -5805,7 +5938,7 @@
|
|
|
5805
5938
|
},
|
|
5806
5939
|
"store": {
|
|
5807
5940
|
"char": "s",
|
|
5808
|
-
"description": "Store URL. It can be the store prefix (
|
|
5941
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5809
5942
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5810
5943
|
"hasDynamicHelp": false,
|
|
5811
5944
|
"multiple": false,
|
|
@@ -5857,6 +5990,7 @@
|
|
|
5857
5990
|
],
|
|
5858
5991
|
"args": {
|
|
5859
5992
|
},
|
|
5993
|
+
"customPluginName": "@shopify/theme",
|
|
5860
5994
|
"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 ",
|
|
5861
5995
|
"descriptionWithMarkdown": "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 ",
|
|
5862
5996
|
"flags": {
|
|
@@ -5913,7 +6047,7 @@
|
|
|
5913
6047
|
},
|
|
5914
6048
|
"store": {
|
|
5915
6049
|
"char": "s",
|
|
5916
|
-
"description": "Store URL. It can be the store prefix (
|
|
6050
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
5917
6051
|
"env": "SHOPIFY_FLAG_STORE",
|
|
5918
6052
|
"hasDynamicHelp": false,
|
|
5919
6053
|
"multiple": false,
|
|
@@ -5968,6 +6102,7 @@
|
|
|
5968
6102
|
"force",
|
|
5969
6103
|
"notify"
|
|
5970
6104
|
],
|
|
6105
|
+
"customPluginName": "@shopify/theme",
|
|
5971
6106
|
"description": "\n Uploads the current theme as the specified theme, or a \"development theme\" (https://shopify.dev/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\" (https://shopify.dev/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\" (https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or \"push\" (https://shopify.dev/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\" (https://shopify.dev/docs/themes/tools/cli#directory-structure).",
|
|
5972
6107
|
"descriptionWithMarkdown": "\n Uploads the current theme as the specified theme, or a [development theme](https://shopify.dev/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](https://shopify.dev/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](https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or [push](https://shopify.dev/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](https://shopify.dev/docs/themes/tools/cli#directory-structure).",
|
|
5973
6108
|
"flags": {
|
|
@@ -6110,7 +6245,7 @@
|
|
|
6110
6245
|
},
|
|
6111
6246
|
"store": {
|
|
6112
6247
|
"char": "s",
|
|
6113
|
-
"description": "Store URL. It can be the store prefix (
|
|
6248
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
6114
6249
|
"env": "SHOPIFY_FLAG_STORE",
|
|
6115
6250
|
"hasDynamicHelp": false,
|
|
6116
6251
|
"multiple": false,
|
|
@@ -6160,6 +6295,7 @@
|
|
|
6160
6295
|
"cli2Flags": [
|
|
6161
6296
|
"force"
|
|
6162
6297
|
],
|
|
6298
|
+
"customPluginName": "@shopify/theme",
|
|
6163
6299
|
"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.",
|
|
6164
6300
|
"descriptionWithMarkdown": "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.",
|
|
6165
6301
|
"flags": {
|
|
@@ -6208,7 +6344,7 @@
|
|
|
6208
6344
|
},
|
|
6209
6345
|
"store": {
|
|
6210
6346
|
"char": "s",
|
|
6211
|
-
"description": "Store URL. It can be the store prefix (
|
|
6347
|
+
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
|
|
6212
6348
|
"env": "SHOPIFY_FLAG_STORE",
|
|
6213
6349
|
"hasDynamicHelp": false,
|
|
6214
6350
|
"multiple": false,
|
|
@@ -6277,6 +6413,7 @@
|
|
|
6277
6413
|
],
|
|
6278
6414
|
"args": {
|
|
6279
6415
|
},
|
|
6416
|
+
"customPluginName": "@shopify/app",
|
|
6280
6417
|
"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\" (https://shopify.dev/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\" (https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ",
|
|
6281
6418
|
"descriptionWithMarkdown": "\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](https://shopify.dev/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](https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ",
|
|
6282
6419
|
"enableJsonFlag": false,
|
|
@@ -6399,5 +6536,5 @@
|
|
|
6399
6536
|
"summary": "Trigger delivery of a sample webhook topic payload to a designated address."
|
|
6400
6537
|
}
|
|
6401
6538
|
},
|
|
6402
|
-
"version": "3.
|
|
6539
|
+
"version": "3.65.1"
|
|
6403
6540
|
}
|