-
Notifications
You must be signed in to change notification settings - Fork 104
/
oclif.manifest.json
6097 lines (6097 loc) · 227 KB
/
oclif.manifest.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"commands": {
"app:build": {
"aliases": [
],
"args": {
},
"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.",
"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.",
"flags": {
"api-key": {
"description": "Application's API key that will be exposed at build time.",
"env": "SHOPIFY_FLAG_API_KEY",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "api-key",
"type": "option"
},
"client-id": {
"description": "Application's Client ID that will be exposed at build time.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-id",
"type": "option"
},
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"skip-dependencies-installation": {
"allowNo": false,
"description": "Skips the installation of dependencies. Deprecated, use workspaces instead.",
"env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION",
"hidden": false,
"name": "skip-dependencies-installation",
"type": "boolean"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:build",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Build the app, including extensions."
},
"app:config:link": {
"aliases": [
],
"args": {
},
"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 ",
"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 ",
"flags": {
"client-id": {
"description": "The Client ID of your app.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-id",
"type": "option"
},
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:config:link",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Fetch your app configuration from the Partner Dashboard."
},
"app:config:use": {
"aliases": [
],
"args": {
"config": {
"description": "The name of the app configuration. Can be 'shopify.app.staging.toml' or simply 'staging'.",
"name": "config"
}
},
"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.",
"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.",
"flags": {
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"reset": {
"allowNo": false,
"description": "Reset current configuration.",
"env": "SHOPIFY_FLAG_RESET",
"hidden": false,
"name": "reset",
"type": "boolean"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:config:use",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Activate an app configuration."
},
"app:deploy": {
"aliases": [
],
"args": {
},
"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 ",
"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 ",
"flags": {
"api-key": {
"description": "The API key of your app.",
"env": "SHOPIFY_FLAG_APP_API_KEY",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "api-key",
"type": "option"
},
"client-id": {
"description": "The Client ID of your app.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-id",
"type": "option"
},
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"force": {
"allowNo": false,
"char": "f",
"description": "Deploy without asking for confirmation.",
"env": "SHOPIFY_FLAG_FORCE",
"hidden": false,
"name": "force",
"type": "boolean"
},
"message": {
"description": "Optional message that will be associated with this version. This is for internal use only and won't be available externally.",
"env": "SHOPIFY_FLAG_MESSAGE",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "message",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"no-release": {
"allowNo": false,
"description": "Creates a version but doesn't release it - it's not made available to merchants.",
"env": "SHOPIFY_FLAG_NO_RELEASE",
"hidden": false,
"name": "no-release",
"type": "boolean"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"reset": {
"allowNo": false,
"description": "Reset all your settings.",
"env": "SHOPIFY_FLAG_RESET",
"exclusive": [
"config"
],
"hidden": false,
"name": "reset",
"type": "boolean"
},
"source-control-url": {
"description": "URL associated with the new app version.",
"env": "SHOPIFY_FLAG_SOURCE_CONTROL_URL",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "source-control-url",
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
},
"version": {
"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.",
"env": "SHOPIFY_FLAG_VERSION",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "version",
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:deploy",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Deploy your Shopify app."
},
"app:dev": {
"aliases": [
],
"args": {
},
"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",
"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",
"flags": {
"api-key": {
"description": "The API key of your app.",
"env": "SHOPIFY_FLAG_APP_API_KEY",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "api-key",
"type": "option"
},
"checkout-cart-url": {
"description": "Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"",
"env": "SHOPIFY_FLAG_CHECKOUT_CART_URL",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "checkout-cart-url",
"type": "option"
},
"client-id": {
"description": "The Client ID of your app.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-id",
"type": "option"
},
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"graphiql-key": {
"description": "Key used to authenticate GraphiQL requests. Should be specified if exposing GraphiQL on a publicly accessible URL. By default, no key is required.",
"env": "SHOPIFY_FLAG_GRAPHIQL_KEY",
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "graphiql-key",
"type": "option"
},
"graphiql-port": {
"description": "Local port of the GraphiQL development server.",
"env": "SHOPIFY_FLAG_GRAPHIQL_PORT",
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "graphiql-port",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"no-tunnel": {
"allowNo": false,
"description": "Automatic creation of a tunnel is disabled. Service entry point will listen to localhost instead",
"env": "SHOPIFY_FLAG_NO_TUNNEL",
"exclusive": [
"tunnel-url",
"tunnel"
],
"hidden": true,
"name": "no-tunnel",
"type": "boolean"
},
"no-update": {
"allowNo": false,
"description": "Skips the Partners Dashboard URL update step.",
"env": "SHOPIFY_FLAG_NO_UPDATE",
"hidden": false,
"name": "no-update",
"type": "boolean"
},
"notify": {
"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.",
"env": "SHOPIFY_FLAG_NOTIFY",
"hasDynamicHelp": false,
"multiple": false,
"name": "notify",
"type": "option"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"reset": {
"allowNo": false,
"description": "Reset all your settings.",
"env": "SHOPIFY_FLAG_RESET",
"exclusive": [
"config"
],
"hidden": false,
"name": "reset",
"type": "boolean"
},
"skip-dependencies-installation": {
"allowNo": false,
"description": "Skips the installation of dependencies. Deprecated, use workspaces instead.",
"env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION",
"hidden": false,
"name": "skip-dependencies-installation",
"type": "boolean"
},
"store": {
"char": "s",
"description": "Store URL. Must be an existing development or Shopify Plus sandbox store.",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "store",
"type": "option"
},
"subscription-product-url": {
"description": "Resource URL for subscription UI extension. Format: \"/products/{productId}\"",
"env": "SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "subscription-product-url",
"type": "option"
},
"theme": {
"char": "t",
"description": "Theme ID or name of the theme app extension host theme.",
"env": "SHOPIFY_FLAG_THEME",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "theme",
"type": "option"
},
"theme-app-extension-port": {
"description": "Local port of the theme app extension development server.",
"env": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "theme-app-extension-port",
"type": "option"
},
"tunnel-url": {
"description": "Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".",
"env": "SHOPIFY_FLAG_TUNNEL_URL",
"exclusive": [
"no-tunnel",
"tunnel"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "tunnel-url",
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:dev",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Run the app."
},
"app:draft-extensions:push": {
"aliases": [
],
"args": {
},
"description": "Updates the content of the app draft version.",
"flags": {
"client-id": {
"description": "The Client ID of your app.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-id",
"type": "option"
},
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"enable-dev-preview": {
"allowNo": false,
"description": "Enable dev preview after the draft content is updated.",
"env": "SHOPIFY_FLAG_ENABLE_DEV_PREVIEW",
"hidden": false,
"name": "enable-dev-preview",
"type": "boolean"
},
"path": {
"default": ".",
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"type": "option"
},
"reset": {
"allowNo": false,
"description": "Reset all your settings.",
"env": "SHOPIFY_FLAG_RESET",
"hidden": false,
"name": "reset",
"type": "boolean"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "app:draft-extensions:push",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true
},
"app:env:pull": {
"aliases": [
],
"args": {
},
"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.",
"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.",
"flags": {
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"env-file": {
"description": "Specify an environment file to update if the update flag is set",
"env": "SHOPIFY_FLAG_ENV_FILE",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "env-file",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:env:pull",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Pull app and extensions environment variables."
},
"app:env:show": {
"aliases": [
],
"args": {
},
"description": "Displays environment variables that can be used to deploy apps and app extensions.",
"descriptionWithMarkdown": "Displays environment variables that can be used to deploy apps and app extensions.",
"flags": {
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your app directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:env:show",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Display app and extensions environment variables."
},
"app:function:build": {
"aliases": [
],
"args": {
},
"description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
"descriptionWithMarkdown": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
"flags": {
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your function directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:function:build",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Compile a function to wasm."
},
"app:function:replay": {
"aliases": [
],
"args": {
},
"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).",
"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).",
"flags": {
"api-key": {
"description": "Application's API key",
"env": "SHOPIFY_FLAG_API_KEY",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "api-key",
"type": "option"
},
"client-id": {
"description": "Application's Client ID",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-id",
"type": "option"
},
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"export": {
"char": "e",
"default": "_start",
"description": "Name of the WebAssembly export to invoke.",
"env": "SHOPIFY_FLAG_EXPORT",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "export",
"type": "option"
},
"json": {
"allowNo": false,
"char": "j",
"description": "Output the function run result as a JSON object.",
"env": "SHOPIFY_FLAG_JSON",
"hidden": false,
"name": "json",
"type": "boolean"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your function directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "app:function:replay",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Replays a function run from an app log."
},
"app:function:run": {
"aliases": [
],
"args": {
},
"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).",
"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).",
"flags": {
"config": {
"char": "c",
"description": "The name of the app configuration.",
"env": "SHOPIFY_FLAG_APP_CONFIG",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "config",
"type": "option"
},
"export": {
"char": "e",
"default": "_start",
"description": "Name of the WebAssembly export to invoke.",
"env": "SHOPIFY_FLAG_EXPORT",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "export",
"type": "option"
},
"input": {
"char": "i",
"description": "The input JSON to pass to the function. If omitted, standard input is used.",
"env": "SHOPIFY_FLAG_INPUT",
"hasDynamicHelp": false,
"multiple": false,
"name": "input",
"type": "option"
},
"json": {
"allowNo": false,
"char": "j",
"description": "Log the run result as a JSON object.",
"env": "SHOPIFY_FLAG_JSON",
"hidden": false,
"name": "json",
"type": "boolean"
},
"no-color": {
"allowNo": false,
"description": "Disable color output.",
"env": "SHOPIFY_FLAG_NO_COLOR",
"hidden": false,
"name": "no-color",
"type": "boolean"
},
"path": {
"description": "The path to your function directory.",
"env": "SHOPIFY_FLAG_PATH",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "path",
"noCacheDefault": true,
"type": "option"
},
"verbose": {
"allowNo": false,
"description": "Increase the verbosity of the logs.",
"env": "SHOPIFY_FLAG_VERBOSE",
"hidden": false,
"name": "verbose",
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:function:run",
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"strict": true,
"summary": "Run a function locally for testing."
},
"app:function:schema": {
"aliases": [
],
"args": {
},
"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.",
"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.",
"flags": {
"api-key": {
"description": "The API key to fetch the schema with.",
"env": "SHOPIFY_FLAG_APP_API_KEY",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": true,
"multiple": false,
"name": "api-key",
"type": "option"
},
"client-id": {
"description": "The Client ID to fetch the schema with.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,