-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
Copy pathwp.ts
11953 lines (11930 loc) · 386 KB
/
wp.ts
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
// https://wp-cli.org/
// wp-cli version 2.5.0
// 19 June 2021
// To learn more about Fig's autocomplete standard visit: https://fig.io/docs/concepts/cli-skeleton
const global_parameter_path: Fig.Option = {
name: "--path",
requiresSeparator: true,
description: "Path to the WordPress files",
args: {
name: "path",
template: "filepaths",
},
};
const global_parameter_url: Fig.Option = {
name: "--url",
requiresSeparator: true,
description:
"Pretend request came from given URL. In multisite, this argument is how the target site is specified",
args: {
name: "url",
},
};
const global_parameter_ssh: Fig.Option = {
name: "--ssh",
requiresSeparator: true,
description:
"Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “vagrant”)",
args: {
name: "options",
suggestions: [
{ name: "scheme:" },
{ name: "user@" },
{ name: "host" },
{ name: "container" },
{ name: ":port" },
{ name: "path" },
],
},
};
const global_parameter_http: Fig.Option = {
name: "--http",
requiresSeparator: true,
description:
"Perform operation against a remote WordPress installation over HTTP",
args: {
name: "http",
},
};
const global_parameter_user: Fig.Option = {
name: "--user",
requiresSeparator: true,
description: "Set the WordPress user",
args: {
name: "options",
suggestions: [{ name: "id" }, { name: "login" }, { name: "email" }],
},
};
const global_parameter_skip_plugins1: Fig.Option = {
name: "--skip-plugins",
description:
"Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded",
};
const global_parameter_skip_plugins2: Fig.Option = {
name: "--skip-plugins",
requiresSeparator: true,
displayName: "--skip-plugins=",
description:
"Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded",
args: {
name: "plugins",
},
};
const global_parameter_skip_themes1: Fig.Option = {
name: "--skip-themes",
description: "Skip loading all themes, or a comma-separated list of themes",
};
const global_parameter_skip_themes2: Fig.Option = {
name: "--skip-themes",
requiresSeparator: true,
displayName: "--skip-themes=",
description: "Skip loading all themes, or a comma-separated list of themes",
args: {
name: "themes",
},
};
const global_parameter_skip_packages: Fig.Option = {
name: "--skip-packages",
description: "Skip loading all installed packages",
};
const global_parameter_require: Fig.Option = {
name: "--require",
requiresSeparator: true,
description:
"Load PHP file before running the command (may be used more than once)",
args: {
name: "path",
},
};
const global_parameter_exec: Fig.Option = {
name: "--exec",
requiresSeparator: true,
description:
"Execute PHP code before running the command (may be used more than once)",
args: {
name: "php-code",
},
};
const global_parameter_color: Fig.Option = {
name: "--color",
description: "Whether to colorize the output",
};
const global_parameter_no_color: Fig.Option = {
name: "--no-color",
description: "Whether to colorize the output",
};
const global_parameter_debug1: Fig.Option = {
name: "--debug",
description:
"Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help",
};
const global_parameter_debug2: Fig.Option = {
name: "--debug",
displayName: "--debug=",
requiresSeparator: true,
description:
"Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help",
args: {
name: "group",
},
};
const global_parameter_prompt1: Fig.Option = {
name: "--prompt",
description:
"Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values",
};
const global_parameter_prompt2: Fig.Option = {
name: "--prompt",
requiresSeparator: true,
displayName: "--prompt=",
description:
"Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values",
args: {
name: "assoc",
},
};
const global_parameter_quiet: Fig.Option = {
name: "--quiet",
description: "Suppress informational messages",
};
// The below is a dummy example for git. Make sure to change the file name!
const completionSpec: Fig.Spec = {
name: "wp",
description: "WP-CLI is the command-line interface for WordPress",
subcommands: [
// {
// name: "admin",
// description: "Open /wp-admin/ in a browser.",
// // If a subcommand or option takes an argument, you must include the args prop, even if it"s an empty object (like below)
// // If you want to build custom suggestions for arguments check out: https://fig.io/docs/concepts/dynamic-suggestions
// args: [{}],
// options: global_parameters,
// },
{
name: "cache",
description:
"Adds, removes, fetches, and flushes the WP Object Cache object",
options: [
global_parameter_path,
global_parameter_url,
global_parameter_ssh,
global_parameter_http,
global_parameter_user,
global_parameter_skip_plugins1,
global_parameter_skip_plugins2,
global_parameter_skip_themes1,
global_parameter_skip_themes2,
global_parameter_skip_packages,
global_parameter_require,
global_parameter_exec,
global_parameter_color,
global_parameter_no_color,
global_parameter_debug1,
global_parameter_debug2,
global_parameter_prompt1,
global_parameter_prompt2,
global_parameter_quiet,
],
subcommands: [
{
name: "add",
description: "Adds a value to the object cache",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "value",
description: "Value to add to the key",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
{
name: "expiration",
description:
"Define how long to keep the value, in seconds. 0 means as long as possible",
},
],
},
{
name: "decr",
description: "Decrements a value in the object cache",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "offset",
description: "The amount by which to decrement the item’s value",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
],
},
{
name: "delete",
description: "Removes a value from the object cache",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
],
},
{
name: "flush",
description: "Flushes the object cache",
},
{
name: "get",
description: "Gets a value from the object cache",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
],
},
{
name: "incr",
description: "Increments a value in the object cache",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "offset",
description: "The amount by which to increment the item’s value",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
],
},
{
name: "replace",
description:
"Replaces a value in the object cache, if the value already exists",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "value",
description: "Value to replace",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
{
name: "expiration",
description:
"Define how long to keep the value, in seconds. 0 means as long as possible",
},
],
},
{
name: "set",
description:
"Sets a value to the object cache, regardless of whether it already exists",
args: [
{
name: "key",
description: "Cache key",
},
{
name: "value",
description: "Value to set on the key",
},
{
name: "group",
description:
"Method for grouping data within the cache which allows the same key to be used across groups",
},
{
name: "expiration",
description:
"Define how long to keep the value, in seconds. 0 means as long as possible",
},
],
},
{
name: "type",
description: "Attempts to determine which object cache is being used",
},
],
},
{
name: "cap",
description: "Adds, removes, and lists capabilities of a user role",
options: [
global_parameter_path,
global_parameter_url,
global_parameter_ssh,
global_parameter_http,
global_parameter_user,
global_parameter_skip_plugins1,
global_parameter_skip_plugins2,
global_parameter_skip_themes1,
global_parameter_skip_themes2,
global_parameter_skip_packages,
global_parameter_require,
global_parameter_exec,
global_parameter_color,
global_parameter_no_color,
global_parameter_debug1,
global_parameter_debug2,
global_parameter_prompt1,
global_parameter_prompt2,
global_parameter_quiet,
],
subcommands: [
{
name: "add",
description: "Adds a value to the object cache",
args: [
{
name: "role",
description: "Key for the role",
},
{
name: "cap",
description: "One or more capabilities to add",
},
],
options: [
{
name: "--grant",
description:
"Adds the capability as an explicit boolean value, instead of implicitly defaulting to true",
args: {
name: "options",
suggestions: [{ name: "true" }, { name: "false" }],
},
},
],
},
{
name: "list",
description: "Lists capabilities for a given role",
args: {
name: "role",
description: "Key for the role",
},
options: [
{
name: "--format",
requiresSeparator: true,
description: "Render output in a particular format",
args: {
name: "options",
suggestions: [
{ name: "list" },
{ name: "table" },
{ name: "csv" },
{ name: "json" },
{ name: "count" },
{ name: "yaml" },
],
},
},
{
name: "--show-grant",
description:
"Display all capabilities defined for a role including grant",
},
],
},
{
name: "remove",
description: "Removes capabilities from a given role",
args: [
{
name: "role",
description: "Key for the role",
},
{
name: "cap",
description: "One or more capabilities to remove",
},
],
},
],
},
{
name: "cli",
description:
"Reviews current WP-CLI info, checks for updates, or views defined aliases",
options: [
global_parameter_path,
global_parameter_url,
global_parameter_ssh,
global_parameter_http,
global_parameter_user,
global_parameter_skip_plugins1,
global_parameter_skip_plugins2,
global_parameter_skip_themes1,
global_parameter_skip_themes2,
global_parameter_skip_packages,
global_parameter_require,
global_parameter_exec,
global_parameter_color,
global_parameter_no_color,
global_parameter_debug1,
global_parameter_debug2,
global_parameter_prompt1,
global_parameter_prompt2,
global_parameter_quiet,
],
subcommands: [
{
name: "alias",
description:
"Retrieves, sets and updates aliases for WordPress Installations",
subcommands: [
{
name: "add",
description: "Creates an alias",
args: {
name: "key",
description: "Key for the alias",
},
options: [
{
name: "--set-user",
requiresSeparator: true,
description: "Set user for alias",
args: { name: "user" },
},
{
name: "--set-url",
requiresSeparator: true,
description: "Set url for alias",
args: { name: "url" },
},
{
name: "--set-path",
requiresSeparator: true,
description: "Set path for alias",
args: {
name: "path",
template: "folders",
},
},
{
name: "--set-ssh",
requiresSeparator: true,
description: "Set ssh for alias",
args: { name: "ssh" },
},
{
name: "--set-http",
requiresSeparator: true,
description: "Set http for alias",
args: { name: "http" },
},
{
name: "--grouping",
requiresSeparator: true,
description: "For grouping multiple aliases",
args: { name: "grouping" },
},
{
name: "--config",
requiresSeparator: true,
description: "Config file to be considered for operations",
args: {
name: "options",
suggestions: [{ name: "global" }, { name: "project" }],
},
},
],
},
{
name: "delete",
description: "Deletes an alias",
args: {
name: "key",
description: "Key for the alias",
},
options: [
{
name: "--config",
requiresSeparator: true,
description: "Config file to be considered for operations",
args: {
name: "options",
suggestions: [{ name: "global" }, { name: "project" }],
},
},
],
},
{
name: "get",
description: "Gets the value for an alias",
args: {
name: "key",
description: "Key for the alias",
},
},
{
name: "list",
description: "Lists available WP-CLI aliases",
options: [
{
name: "--format",
requiresSeparator: true,
description: "Set user for alias",
args: {
name: "options",
suggestions: [
{ name: "yaml" },
{ name: "json" },
{ name: "var_export" },
],
},
},
],
},
{
name: "update",
description: "Updates an alias",
args: {
name: "key",
description: "Key for the alias",
},
options: [
{
name: "--set-user",
requiresSeparator: true,
description: "Set user for alias",
args: { name: "user" },
},
{
name: "--set-url",
requiresSeparator: true,
description: "Set url for alias",
args: { name: "url" },
},
{
name: "--set-path",
requiresSeparator: true,
description: "Set path for alias",
args: {
name: "path",
template: "folders",
},
},
{
name: "--set-ssh",
requiresSeparator: true,
description: "Set ssh for alias",
args: { name: "ssh" },
},
{
name: "--set-http",
requiresSeparator: true,
description: "Set http for alias",
args: { name: "http" },
},
{
name: "--grouping",
requiresSeparator: true,
description: "For grouping multiple aliases",
args: { name: "grouping" },
},
{
name: "--config",
requiresSeparator: true,
description: "Config file to be considered for operations",
args: {
name: "options",
suggestions: [{ name: "global" }, { name: "project" }],
},
},
],
},
],
},
{
name: "cache",
description: "Manages the internal WP-CLI cache,",
subcommands: [
{
name: "clear",
description: "Clears the internal cache",
},
{
name: "prune",
description: "Prunes the internal cache",
},
],
},
{
name: "check-update",
description:
"Checks to see if there is a newer version of WP-CLI available",
options: [
{
name: "--patch",
description: "Only list patch updates",
},
{
name: "--minor",
description: "Only list minor updates",
},
{
name: "--major",
description: "Only list major updates",
},
{
name: "--field",
requiresSeparator: true,
description: "Prints the value of a single field for each update",
args: { name: "field" },
},
{
name: "--fields",
requiresSeparator: true,
description:
"Limit the output to specific object fields. Defaults to version,update_type,package_url",
args: { name: "fields" },
},
{
name: "--format",
requiresSeparator: true,
description: "Render output in a particular format",
args: {
name: "options",
suggestions: [
{ name: "table" },
{ name: "csv" },
{ name: "json" },
{ name: "count" },
{ name: "yaml" },
],
},
},
],
},
{
name: "cmd-dump",
description: "Dumps the list of installed commands, as JSON",
},
{
name: "completions",
description: "Generates tab completion strings",
options: [
{
name: "--line",
requiresSeparator: true,
description: "The current command line to be executed",
args: { name: "line" },
},
{
name: "--point",
requiresSeparator: true,
description:
"The index to the current cursor position relative to the beginning of the command",
args: { name: "point" },
},
],
},
{
name: "has-command",
description: "Detects if a command exists",
args: {
name: "command_name",
description: "The command",
},
},
{
name: "info",
description: "Prints various details about the WP-CLI environment",
options: [
{
name: "--format",
requiresSeparator: true,
description: "Render output in a particular format",
args: {
name: "options",
suggestions: [{ name: "list" }, { name: "json" }],
},
},
],
},
{
name: "param-dump",
description:
"Dumps the list of global parameters, as JSON or in var_export format",
options: [
{
name: "--with-values",
description: "Display current values also",
},
{
name: "--format",
requiresSeparator: true,
description: "Render output in a particular format",
args: {
name: "options",
suggestions: [{ name: "var_export" }, { name: "json" }],
},
},
],
},
{
name: "update",
description: "Updates WP-CLI to the latest release",
options: [
{
name: "--patch",
description: "Only perform patch updates",
},
{
name: "--minor",
description: "Only perform minor updates",
},
{
name: "--major",
description: "Only perform major updates",
},
{
name: "--stable",
description:
"Update to the latest stable release. Skips update check",
},
{
name: "--nightly",
description:
"Update to the latest built version of the master branch. Potentially unstable",
},
{
name: "--yes",
description: "Do not prompt for confirmation",
},
{
name: "--insecure",
description:
"Retry without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack",
},
],
},
{
name: "version",
description: "Prints WP-CLI version",
},
],
},
{
name: "comment",
description: "Creates, updates, deletes, and moderates comments",
options: [
global_parameter_path,
global_parameter_url,
global_parameter_ssh,
global_parameter_http,
global_parameter_user,
global_parameter_skip_plugins1,
global_parameter_skip_plugins2,
global_parameter_skip_themes1,
global_parameter_skip_themes2,
global_parameter_skip_packages,
global_parameter_require,
global_parameter_exec,
global_parameter_color,
global_parameter_no_color,
global_parameter_debug1,
global_parameter_debug2,
global_parameter_prompt1,
global_parameter_prompt2,
global_parameter_quiet,
],
subcommands: [
{
name: "approve",
description: "Approves a comment",
args: {
name: "id",
description: "The IDs of the comments to approve",
},
},
{
name: "count",
description: "Counts comments, on whole blog or on a given post",
args: {
name: "post-id",
description: "The ID of the post to count comments in",
},
},
{
name: "create",
description: "Creates a new comment",
options: [
{
name: "--field=value",
insertValue: "--",
description:
"Associative args for the new comment. See wp_insert_comment()",
args: { name: "field" },
},
{
name: "--porcelain",
description: "Output just the new comment id",
},
],
},
{
name: "delete",
description: "Deletes a comment",
args: {
name: "id",
description: "One or more IDs of comments to delete",
},
options: [
{
name: "--force",
description: "Skip the trash bin",
},
],
},
{
name: "exists",
description: "Verifies whether a comment exists",
args: {
name: "id",
description: "The ID of the comment to check",
},
},
{
name: "generate",
description: "Generates some number of new dummy comments",
options: [
{
name: "--count",
requiresSeparator: true,
description: "How many comments to generate?",
args: {
name: "default",
suggestions: [{ name: "100" }],
},
},
{
name: "--post_id",
requiresSeparator: true,
description: "Assign comments to a specific post",
args: {
name: "post-id",
},
},
{
name: "--format",
requiresSeparator: true,
description: "Render output in a particular format",
args: {
name: "options",
suggestions: [{ name: "progress" }, { name: "ids" }],
},
},
],
},
{
name: "get",
description: "Gets the data of a single comment",
args: {
name: "id",
description: "The comment to get",
},
options: [
{
name: "--field",
requiresSeparator: true,
description:
"Instead of returning the whole comment, returns the value of a single field",
args: {
name: "field",
},
},
{
name: "--fields",
requiresSeparator: true,
description:
"Limit the output to specific fields. Defaults to all fields",
args: {
name: "fields",
},
},
{
name: "--format",
requiresSeparator: true,
description: "Render output in a particular format",
args: {
name: "options",
suggestions: [
{ name: "table" },
{ name: "csv" },
{ name: "json" },
{ name: "yaml" },
],
},
},
],
},
{
name: "list",
description: "Gets a list of comments",
options: [
{
name: "--field=value",
insertValue: "--",
description: "One or more args to pass to WP_Comment_Query",
},
{
name: "--field",
requiresSeparator: true,
description:
"Prints the value of a single field for each comment",
args: {
name: "field",
},
},
{
name: "--fields",
requiresSeparator: true,
description: "Limit the output to specific object fields",
args: {