forked from Shopify/hydrogen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoclif.manifest.json
1590 lines (1590 loc) · 55.8 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": {
"hydrogen:build": {
"aliases": [],
"args": {},
"description": "Builds a Hydrogen storefront for production.",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"entry": {
"description": "Entry file for the worker. Defaults to `./server`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ENTRY",
"name": "entry",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"sourcemap": {
"description": "Controls whether sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.",
"env": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP",
"name": "sourcemap",
"allowNo": true,
"type": "boolean"
},
"lockfile-check": {
"description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.",
"env": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK",
"name": "lockfile-check",
"allowNo": true,
"type": "boolean"
},
"disable-route-warning": {
"description": "Disables any warnings about missing standard routes.",
"env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING",
"name": "disable-route-warning",
"allowNo": false,
"type": "boolean"
},
"codegen": {
"description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
"name": "codegen",
"required": false,
"allowNo": false,
"type": "boolean"
},
"codegen-config-path": {
"dependsOn": [
"codegen"
],
"description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
"name": "codegen-config-path",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"diff": {
"description": "Applies the current files on top of Hydrogen's starter template in a temporary directory.",
"hidden": true,
"name": "diff",
"required": false,
"allowNo": false,
"type": "boolean"
},
"bundle-stats": {
"description": "[Classic Remix Compiler] Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.",
"name": "bundle-stats",
"allowNo": true,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:build",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"descriptionWithMarkdown": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"build.js"
]
},
"hydrogen:check": {
"aliases": [],
"args": {
"resource": {
"description": "The resource to check. Currently only 'routes' is supported.",
"name": "resource",
"options": [
"routes"
],
"required": true
}
},
"description": "Returns diagnostic information about a Hydrogen storefront.",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:check",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"descriptionWithMarkdown": "Checks whether your Hydrogen app includes a set of standard Shopify routes.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"check.js"
]
},
"hydrogen:codegen": {
"aliases": [],
"args": {},
"description": "Generate types for the Storefront API queries found in your project.",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"codegen-config-path": {
"description": "Specify a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if it exists.",
"name": "codegen-config-path",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"force-sfapi-version": {
"description": "Force generating Storefront API types for a specific version instead of using the one provided in Hydrogen. A token can also be provided with this format: `<version>:<token>`.",
"hidden": true,
"name": "force-sfapi-version",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"watch": {
"description": "Watch the project for changes to update types on file save.",
"name": "watch",
"required": false,
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:codegen",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"descriptionWithMarkdown": "Automatically generates GraphQL types for your project’s Storefront API queries.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"codegen.js"
]
},
"hydrogen:customer-account:push": {
"aliases": [],
"args": {},
"description": "Push project configuration to admin",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"storefront-id": {
"description": "The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'",
"name": "storefront-id",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"dev-origin": {
"description": "The development domain of your application.",
"name": "dev-origin",
"required": true,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"relative-redirect-uri": {
"description": "The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'",
"name": "relative-redirect-uri",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"relative-logout-uri": {
"description": "The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.",
"name": "relative-logout-uri",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:customer-account:push",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"customer-account",
"push.js"
]
},
"hydrogen:debug:cpu": {
"aliases": [],
"args": {},
"description": "Builds and profiles the server startup time the app.",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"output": {
"description": "Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".",
"name": "output",
"required": false,
"default": "startup.cpuprofile",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:debug:cpu",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"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).",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"debug",
"cpu.js"
]
},
"hydrogen:deploy": {
"aliases": [],
"args": {},
"description": "Builds and deploys a Hydrogen storefront to Oxygen.",
"flags": {
"entry": {
"description": "Entry file for the worker. Defaults to `./server`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ENTRY",
"name": "entry",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env": {
"description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
"exclusive": [
"env-branch"
],
"name": "env",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env-branch": {
"deprecated": {
"to": "env",
"message": "--env-branch is deprecated. Use --env instead."
},
"description": "Specifies the environment to perform the operation using its Git branch name.",
"env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH",
"name": "env-branch",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env-file": {
"description": "Path to an environment file to override existing environment variables for the deployment.",
"name": "env-file",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"preview": {
"description": "Deploys to the Preview environment. Overrides --env-branch and Git metadata.",
"name": "preview",
"required": false,
"allowNo": false,
"type": "boolean"
},
"force": {
"char": "f",
"description": "Forces a deployment to proceed if there are uncommited changes in its Git repository.",
"env": "SHOPIFY_HYDROGEN_FLAG_FORCE",
"name": "force",
"required": false,
"allowNo": false,
"type": "boolean"
},
"no-verify": {
"description": "Skip the routability verification step after deployment.",
"name": "no-verify",
"required": false,
"allowNo": false,
"type": "boolean"
},
"auth-bypass-token": {
"description": "Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.",
"name": "auth-bypass-token",
"required": false,
"allowNo": false,
"type": "boolean"
},
"build-command": {
"description": "Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.",
"name": "build-command",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"lockfile-check": {
"description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.",
"env": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK",
"name": "lockfile-check",
"allowNo": true,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"shop": {
"char": "s",
"description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).",
"env": "SHOPIFY_SHOP",
"name": "shop",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"json-output": {
"description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.",
"name": "json-output",
"required": false,
"allowNo": true,
"type": "boolean"
},
"token": {
"char": "t",
"description": "Oxygen deployment token. Defaults to the linked storefront's token if available.",
"env": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN",
"name": "token",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"metadata-description": {
"description": "Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.",
"env": "SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION",
"name": "metadata-description",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"metadata-url": {
"env": "SHOPIFY_HYDROGEN_FLAG_METADATA_URL",
"hidden": true,
"name": "metadata-url",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"metadata-user": {
"description": "User that initiated the deployment. Will be saved and displayed in the Shopify admin",
"env": "SHOPIFY_HYDROGEN_FLAG_METADATA_USER",
"name": "metadata-user",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"metadata-version": {
"env": "SHOPIFY_HYDROGEN_FLAG_METADATA_VERSION",
"hidden": true,
"name": "metadata-version",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"diff": {
"description": "Applies the current files on top of Hydrogen's starter template in a temporary directory.",
"hidden": true,
"name": "diff",
"required": false,
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:deploy",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"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.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"deploy.js"
]
},
"hydrogen:dev": {
"aliases": [],
"args": {},
"description": "Runs Hydrogen storefront in an Oxygen worker for development.",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"entry": {
"description": "Entry file for the worker. Defaults to `./server`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ENTRY",
"name": "entry",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"port": {
"description": "The port to run the server on. Defaults to 3000.",
"env": "SHOPIFY_HYDROGEN_FLAG_PORT",
"name": "port",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"codegen": {
"description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
"name": "codegen",
"required": false,
"allowNo": false,
"type": "boolean"
},
"codegen-config-path": {
"dependsOn": [
"codegen"
],
"description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
"name": "codegen-config-path",
"required": false,
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"disable-virtual-routes": {
"description": "Disable rendering fallback routes when a route file doesn't exist.",
"env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES",
"name": "disable-virtual-routes",
"allowNo": false,
"type": "boolean"
},
"debug": {
"description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.",
"env": "SHOPIFY_HYDROGEN_FLAG_DEBUG",
"name": "debug",
"allowNo": false,
"type": "boolean"
},
"inspector-port": {
"description": "The port where the inspector is available. Defaults to 9229.",
"env": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT",
"name": "inspector-port",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env": {
"description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
"exclusive": [
"env-branch"
],
"name": "env",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env-branch": {
"deprecated": {
"to": "env",
"message": "--env-branch is deprecated. Use --env instead."
},
"description": "Specifies the environment to perform the operation using its Git branch name.",
"env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH",
"name": "env-branch",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"disable-version-check": {
"description": "Skip the version check when running `hydrogen dev`",
"name": "disable-version-check",
"required": false,
"allowNo": false,
"type": "boolean"
},
"diff": {
"description": "Applies the current files on top of Hydrogen's starter template in a temporary directory.",
"hidden": true,
"name": "diff",
"required": false,
"allowNo": false,
"type": "boolean"
},
"customer-account-push__unstable": {
"description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's Oauth flow",
"env": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH",
"hidden": true,
"name": "customer-account-push__unstable",
"required": false,
"allowNo": false,
"type": "boolean"
},
"verbose": {
"description": "Outputs more information about the command's execution.",
"env": "SHOPIFY_HYDROGEN_FLAG_VERBOSE",
"name": "verbose",
"required": false,
"allowNo": false,
"type": "boolean"
},
"host": {
"description": "Expose the server to the local network",
"name": "host",
"required": false,
"allowNo": false,
"type": "boolean"
},
"disable-deps-optimizer": {
"description": "Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically",
"env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER",
"name": "disable-deps-optimizer",
"allowNo": false,
"type": "boolean"
},
"worker": {
"hidden": true,
"name": "worker",
"type": "boolean"
},
"legacy-runtime": {
"description": "[Classic Remix Compiler] Runs the app in a Node.js sandbox instead of an Oxygen worker.",
"env": "SHOPIFY_HYDROGEN_FLAG_LEGACY_RUNTIME",
"name": "legacy-runtime",
"allowNo": false,
"type": "boolean"
},
"sourcemap": {
"description": "[Classic Remix Compiler] Controls whether sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.",
"env": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP",
"name": "sourcemap",
"allowNo": true,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:dev",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"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.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"dev.js"
]
},
"hydrogen:env:list": {
"aliases": [],
"args": {},
"description": "List the environments on your linked Hydrogen storefront.",
"flags": {
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:env:list",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"descriptionWithMarkdown": "Lists all environments available on the linked Hydrogen storefront.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"env",
"list.js"
]
},
"hydrogen:env:pull": {
"aliases": [],
"args": {},
"description": "Populate your .env with variables from your Hydrogen storefront.",
"flags": {
"env": {
"description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
"exclusive": [
"env-branch"
],
"name": "env",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env-branch": {
"deprecated": {
"to": "env",
"message": "--env-branch is deprecated. Use --env instead."
},
"description": "Specifies the environment to perform the operation using its Git branch name.",
"env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH",
"name": "env-branch",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"force": {
"char": "f",
"description": "Overwrites the destination directory and files if they already exist.",
"env": "SHOPIFY_HYDROGEN_FLAG_FORCE",
"name": "force",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:env:pull",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"descriptionWithMarkdown": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"env",
"pull.js"
]
},
"hydrogen:env:push": {
"aliases": [],
"args": {},
"description": "Push environment variables from the local .env file to your linked Hydrogen storefront.",
"flags": {
"env": {
"description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
"exclusive": [
"env-branch"
],
"name": "env",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"env-file": {
"description": "Path to an environment file to override existing environment variables for the selected environment. Defaults to the '.env' located in your project path `--path`.",
"name": "env-file",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:env:push",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"env",
"push.js"
]
},
"hydrogen:g": {
"aliases": [],
"args": {},
"description": "Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.",
"flags": {},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [],
"id": "hydrogen:g",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": false,
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"g.js"
]
},
"hydrogen:generate:route": {
"aliases": [],
"args": {
"routeName": {
"description": "The route to generate. One of home,page,cart,products,collections,policies,blogs,account,search,robots,sitemap,all.",
"name": "routeName",
"options": [
"home",
"page",
"cart",
"products",
"collections",
"policies",
"blogs",
"account",
"search",
"robots",
"sitemap",
"all"
],
"required": true
}
},
"description": "Generates a standard Shopify route.",
"flags": {
"adapter": {
"description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER",
"name": "adapter",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"typescript": {
"description": "Generate TypeScript files",
"env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT",
"name": "typescript",
"allowNo": false,
"type": "boolean"
},
"locale-param": {
"description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).",
"env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER",
"name": "locale-param",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"force": {
"char": "f",
"description": "Overwrites the destination directory and files if they already exist.",
"env": "SHOPIFY_HYDROGEN_FLAG_FORCE",
"name": "force",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:generate:route",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"descriptionWithMarkdown": "Generates a set of default routes from the starter template.",
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"generate",
"route.js"
]
},
"hydrogen:generate:routes": {
"aliases": [],
"args": {},
"description": "Generates all supported standard shopify routes.",
"flags": {
"adapter": {
"description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.",
"env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER",
"name": "adapter",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"typescript": {
"description": "Generate TypeScript files",
"env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT",
"name": "typescript",
"allowNo": false,
"type": "boolean"
},
"locale-param": {
"description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).",
"env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER",
"name": "locale-param",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"force": {
"char": "f",
"description": "Overwrites the destination directory and files if they already exist.",
"env": "SHOPIFY_HYDROGEN_FLAG_FORCE",
"name": "force",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "hydrogen:generate:routes",
"pluginAlias": "@shopify/cli-hydrogen",
"pluginName": "@shopify/cli-hydrogen",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"hydrogen",
"generate",
"routes.js"
]
},
"hydrogen:init": {
"aliases": [],
"args": {},
"description": "Creates a new Hydrogen storefront.",
"flags": {
"force": {
"char": "f",
"description": "Overwrites the destination directory and files if they already exist.",
"env": "SHOPIFY_HYDROGEN_FLAG_FORCE",
"name": "force",
"allowNo": false,
"type": "boolean"
},
"path": {
"description": "The path to the directory of the new Hydrogen storefront.",
"env": "SHOPIFY_HYDROGEN_FLAG_PATH",
"name": "path",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"language": {
"description": "Sets the template language to use. One of `js` or `ts`.",
"env": "SHOPIFY_HYDROGEN_FLAG_LANGUAGE",
"name": "language",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"template": {
"description": "Scaffolds project based on an existing template or example from the Hydrogen repository.",
"env": "SHOPIFY_HYDROGEN_FLAG_TEMPLATE",
"name": "template",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"install-deps": {
"description": "Auto installs dependencies using the active package manager.",
"env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS",
"name": "install-deps",
"allowNo": true,
"type": "boolean"
},
"mock-shop": {
"description": "Use mock.shop as the data source for the storefront.",
"env": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA",
"name": "mock-shop",
"allowNo": false,
"type": "boolean"
},
"markets": {
"description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.",
"env": "SHOPIFY_HYDROGEN_FLAG_I18N",
"name": "markets",
"hasDynamicHelp": false,