@teambit/harmony.content.cli-reference 2.0.323 → 2.0.325

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.
@@ -1,52 +1,4 @@
1
1
  [
2
- {
3
- "name": "config",
4
- "alias": "",
5
- "options": [],
6
- "description": "global config management",
7
- "extendedDescription": "https://bit.dev/reference/config/bit-config",
8
- "group": "general",
9
- "private": false,
10
- "commands": [
11
- {
12
- "name": "set <key> <val>",
13
- "alias": "",
14
- "options": [],
15
- "description": "set a global configuration",
16
- "extendedDescription": "to set temporary configuration by env variable, prefix with \"BIT_CONFIG\", replace \".\" with \"_\" and change to upper case.\nfor example, \"user.token\" becomes \"BIT_CONFIG_USER_TOKEN\"",
17
- "group": "ungrouped",
18
- "private": false,
19
- "skipWorkspace": true
20
- },
21
- {
22
- "name": "del <key>",
23
- "alias": "",
24
- "options": [],
25
- "description": "delete given key from global configuration",
26
- "extendedDescription": "",
27
- "group": "ungrouped",
28
- "private": false
29
- },
30
- {
31
- "name": "get <key>",
32
- "alias": "",
33
- "options": [],
34
- "description": "get a value from global configuration",
35
- "extendedDescription": "",
36
- "group": "ungrouped",
37
- "private": false
38
- },
39
- {
40
- "name": "list",
41
- "alias": "",
42
- "options": [],
43
- "description": "list all configuration(s)",
44
- "extendedDescription": "",
45
- "group": "ungrouped",
46
- "private": false
47
- }
48
- ]
49
- },
50
2
  {
51
3
  "name": "remote",
52
4
  "alias": "",
@@ -94,160 +46,6 @@
94
46
  }
95
47
  ]
96
48
  },
97
- {
98
- "name": "cat-object <hash>",
99
- "alias": "",
100
- "options": [
101
- [
102
- "p",
103
- "pretty",
104
- "pretty print for the objects"
105
- ],
106
- [
107
- "s",
108
- "stringify",
109
- "JSON.stringify the object to see special characters, such as \"\n\""
110
- ],
111
- [
112
- "",
113
- "headers",
114
- "shows the headers only"
115
- ]
116
- ],
117
- "description": "cat a bit object by hash",
118
- "extendedDescription": "",
119
- "group": "ungrouped",
120
- "private": true
121
- },
122
- {
123
- "name": "cat-component [id]",
124
- "alias": "cmp",
125
- "options": [
126
- [
127
- "j",
128
- "json",
129
- "json format"
130
- ]
131
- ],
132
- "description": "cat a bit object by component-id",
133
- "extendedDescription": "",
134
- "group": "ungrouped",
135
- "private": true
136
- },
137
- {
138
- "name": "cat-lane <id>",
139
- "alias": "cl",
140
- "options": [],
141
- "description": "cat a bit object by lane-name",
142
- "extendedDescription": "",
143
- "group": "ungrouped",
144
- "private": true
145
- },
146
- {
147
- "name": "dependents <component-name>",
148
- "alias": "",
149
- "options": [],
150
- "description": "show dependents of the given component",
151
- "extendedDescription": "",
152
- "group": "info",
153
- "private": false
154
- },
155
- {
156
- "name": "cat-scope [scopePath]",
157
- "alias": "",
158
- "options": [
159
- [
160
- "f",
161
- "full",
162
- "show all of the objects in the scope (except \"Source\")"
163
- ],
164
- [
165
- "j",
166
- "json",
167
- "print the objects as a json format"
168
- ],
169
- [
170
- "e",
171
- "json-extra",
172
- "add hash and object type to the json"
173
- ]
174
- ],
175
- "description": "cat a scope and show all the contents",
176
- "extendedDescription": "",
177
- "group": "ungrouped",
178
- "private": true
179
- },
180
- {
181
- "name": "cat-version-history <id>",
182
- "alias": "cvh",
183
- "options": [
184
- [
185
- "j",
186
- "json",
187
- "json format"
188
- ]
189
- ],
190
- "description": "cat version-history object by component-id",
191
- "extendedDescription": "",
192
- "group": "ungrouped",
193
- "private": true
194
- },
195
- {
196
- "name": "scope-config",
197
- "alias": "",
198
- "options": [],
199
- "description": "scope config management",
200
- "extendedDescription": "",
201
- "group": "general",
202
- "private": false,
203
- "commands": [
204
- {
205
- "name": "set <key> <val>",
206
- "alias": "",
207
- "options": [],
208
- "description": "set a scope configuration",
209
- "extendedDescription": "",
210
- "group": "ungrouped",
211
- "private": true
212
- },
213
- {
214
- "name": "del <key>",
215
- "alias": "",
216
- "options": [],
217
- "description": "delete given key from global configuration",
218
- "extendedDescription": "",
219
- "group": "ungrouped",
220
- "private": false
221
- },
222
- {
223
- "name": "get <key>",
224
- "alias": "",
225
- "options": [],
226
- "description": "get a scope configuration",
227
- "extendedDescription": "",
228
- "group": "ungrouped",
229
- "private": true
230
- },
231
- {
232
- "name": "list",
233
- "alias": "",
234
- "options": [],
235
- "description": "list all scope configuration(s)",
236
- "extendedDescription": "",
237
- "group": "ungrouped",
238
- "private": false
239
- }
240
- ]
241
- },
242
- {
243
- "name": "run-action <action-name> <remote> <options>",
244
- "alias": "",
245
- "options": [],
246
- "description": "run an action on a remote",
247
- "extendedDescription": "",
248
- "group": "ungrouped",
249
- "private": true
250
- },
251
49
  {
252
50
  "name": "completion",
253
51
  "alias": "",
@@ -493,6 +291,54 @@
493
291
  }
494
292
  ]
495
293
  },
294
+ {
295
+ "name": "config",
296
+ "alias": "",
297
+ "options": [],
298
+ "description": "global config management",
299
+ "extendedDescription": "https://bit.dev/reference/config/bit-config",
300
+ "group": "general",
301
+ "private": false,
302
+ "commands": [
303
+ {
304
+ "name": "set <key> <val>",
305
+ "alias": "",
306
+ "options": [],
307
+ "description": "set a global configuration",
308
+ "extendedDescription": "to set temporary configuration by env variable, prefix with \"BIT_CONFIG\", replace \".\" with \"_\" and change to upper case.\nfor example, \"user.token\" becomes \"BIT_CONFIG_USER_TOKEN\"",
309
+ "group": "ungrouped",
310
+ "private": false,
311
+ "skipWorkspace": true
312
+ },
313
+ {
314
+ "name": "del <key>",
315
+ "alias": "",
316
+ "options": [],
317
+ "description": "delete given key from global configuration",
318
+ "extendedDescription": "",
319
+ "group": "ungrouped",
320
+ "private": false
321
+ },
322
+ {
323
+ "name": "get <key>",
324
+ "alias": "",
325
+ "options": [],
326
+ "description": "get a value from global configuration",
327
+ "extendedDescription": "",
328
+ "group": "ungrouped",
329
+ "private": false
330
+ },
331
+ {
332
+ "name": "list",
333
+ "alias": "",
334
+ "options": [],
335
+ "description": "list all configuration(s)",
336
+ "extendedDescription": "",
337
+ "group": "ungrouped",
338
+ "private": false
339
+ }
340
+ ]
341
+ },
496
342
  {
497
343
  "name": "show <component-name>",
498
344
  "alias": "",
@@ -906,6 +752,89 @@
906
752
  }
907
753
  ]
908
754
  },
755
+ {
756
+ "name": "cat-scope [scopePath]",
757
+ "alias": "",
758
+ "options": [
759
+ [
760
+ "f",
761
+ "full",
762
+ "show all of the objects in the scope (except \"Source\")"
763
+ ],
764
+ [
765
+ "j",
766
+ "json",
767
+ "print the objects as a json format"
768
+ ],
769
+ [
770
+ "e",
771
+ "json-extra",
772
+ "add hash and object type to the json"
773
+ ]
774
+ ],
775
+ "description": "cat a scope and show all the contents",
776
+ "extendedDescription": "",
777
+ "group": "ungrouped",
778
+ "private": true
779
+ },
780
+ {
781
+ "name": "cat-component [id]",
782
+ "alias": "cmp",
783
+ "options": [
784
+ [
785
+ "j",
786
+ "json",
787
+ "json format"
788
+ ]
789
+ ],
790
+ "description": "cat a bit object by component-id",
791
+ "extendedDescription": "",
792
+ "group": "ungrouped",
793
+ "private": true
794
+ },
795
+ {
796
+ "name": "cat-object <hash>",
797
+ "alias": "",
798
+ "options": [
799
+ [
800
+ "p",
801
+ "pretty",
802
+ "pretty print for the objects"
803
+ ],
804
+ [
805
+ "s",
806
+ "stringify",
807
+ "JSON.stringify the object to see special characters, such as \"\n\""
808
+ ],
809
+ [
810
+ "",
811
+ "headers",
812
+ "shows the headers only"
813
+ ]
814
+ ],
815
+ "description": "cat a bit object by hash",
816
+ "extendedDescription": "",
817
+ "group": "ungrouped",
818
+ "private": true
819
+ },
820
+ {
821
+ "name": "cat-lane <id>",
822
+ "alias": "cl",
823
+ "options": [],
824
+ "description": "cat a bit object by lane-name",
825
+ "extendedDescription": "",
826
+ "group": "ungrouped",
827
+ "private": true
828
+ },
829
+ {
830
+ "name": "run-action <action-name> <remote> <options>",
831
+ "alias": "",
832
+ "options": [],
833
+ "description": "run an action on a remote",
834
+ "extendedDescription": "",
835
+ "group": "ungrouped",
836
+ "private": true
837
+ },
909
838
  {
910
839
  "name": "version-history <sub-command>",
911
840
  "alias": "vh",
@@ -1003,6 +932,21 @@
1003
932
  }
1004
933
  ]
1005
934
  },
935
+ {
936
+ "name": "cat-version-history <id>",
937
+ "alias": "cvh",
938
+ "options": [
939
+ [
940
+ "j",
941
+ "json",
942
+ "json format"
943
+ ]
944
+ ],
945
+ "description": "cat version-history object by component-id",
946
+ "extendedDescription": "",
947
+ "group": "ungrouped",
948
+ "private": true
949
+ },
1006
950
  {
1007
951
  "name": "eject-conf <pattern>",
1008
952
  "alias": "",
@@ -1502,6 +1446,58 @@
1502
1446
  }
1503
1447
  ]
1504
1448
  },
1449
+ {
1450
+ "name": "dependents <component-name>",
1451
+ "alias": "",
1452
+ "options": [],
1453
+ "description": "show dependents of the given component",
1454
+ "extendedDescription": "",
1455
+ "group": "info",
1456
+ "private": false,
1457
+ "arguments": [
1458
+ {
1459
+ "name": "component-name",
1460
+ "description": "component name or component id"
1461
+ }
1462
+ ]
1463
+ },
1464
+ {
1465
+ "name": "list [remote-scope]",
1466
+ "alias": "ls",
1467
+ "options": [
1468
+ [
1469
+ "i",
1470
+ "ids",
1471
+ "show only component ids, unformatted"
1472
+ ],
1473
+ [
1474
+ "s",
1475
+ "scope",
1476
+ "show only components stored in the local scope, including indirect dependencies"
1477
+ ],
1478
+ [
1479
+ "o",
1480
+ "outdated",
1481
+ "highlight outdated components, in comparison with their latest remote version (if one exists)"
1482
+ ],
1483
+ [
1484
+ "j",
1485
+ "json",
1486
+ "show the output in JSON format"
1487
+ ],
1488
+ [
1489
+ "n",
1490
+ "namespace <string>",
1491
+ "show only components in the specified namespace/s e.g. '-n ui' or '*/ui'"
1492
+ ]
1493
+ ],
1494
+ "description": "list components on a workspace or a remote scope (with flag).",
1495
+ "extendedDescription": "",
1496
+ "group": "discover",
1497
+ "private": false,
1498
+ "remoteOp": true,
1499
+ "skipWorkspace": true
1500
+ },
1505
1501
  {
1506
1502
  "name": "ws-config <sub-command>",
1507
1503
  "alias": "workspace-config",
@@ -3537,7 +3533,7 @@
3537
3533
  ]
3538
3534
  },
3539
3535
  {
3540
- "name": "merge [ids...]",
3536
+ "name": "merge [component-pattern]",
3541
3537
  "alias": "",
3542
3538
  "options": [
3543
3539
  [
@@ -3597,9 +3593,15 @@
3597
3593
  ]
3598
3594
  ],
3599
3595
  "description": "merge changes of the remote head into local - auto-snaps all merged components",
3600
- "extendedDescription": "merge changes of the remote head into local when they are diverged. when on a lane, merge the remote head of the lane into the local\nand creates snaps for merged components that have diverged, on the lane.\nif no ids are specified, all pending-merge components will be merged. (run \"bit status\" to list them).\noptionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command.\nyou can use a pattern for multiple ids, such as bit merge \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
3596
+ "extendedDescription": "merge changes of the remote head into local when they are diverged. when on a lane, merge the remote head of the lane into the local\nand creates snaps for merged components that have diverged, on the lane.\nif no ids are specified, all pending-merge components will be merged. (run \"bit status\" to list them).\noptionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command.",
3601
3597
  "group": "development",
3602
- "private": false
3598
+ "private": false,
3599
+ "arguments": [
3600
+ {
3601
+ "name": "component-pattern",
3602
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
3603
+ }
3604
+ ]
3603
3605
  },
3604
3606
  {
3605
3607
  "name": "lane [sub-command]",
@@ -4310,43 +4312,6 @@
4310
4312
  }
4311
4313
  ]
4312
4314
  },
4313
- {
4314
- "name": "list [remote-scope]",
4315
- "alias": "ls",
4316
- "options": [
4317
- [
4318
- "i",
4319
- "ids",
4320
- "show only component ids, unformatted"
4321
- ],
4322
- [
4323
- "s",
4324
- "scope",
4325
- "show only components stored in the local scope, including indirect dependencies"
4326
- ],
4327
- [
4328
- "o",
4329
- "outdated",
4330
- "highlight outdated components, in comparison with their latest remote version (if one exists)"
4331
- ],
4332
- [
4333
- "j",
4334
- "json",
4335
- "show the output in JSON format"
4336
- ],
4337
- [
4338
- "n",
4339
- "namespace <string>",
4340
- "show only components in the specified namespace/s e.g. '-n ui' or '*/ui'"
4341
- ]
4342
- ],
4343
- "description": "list components on a workspace or a remote scope (with flag).",
4344
- "extendedDescription": "",
4345
- "group": "discover",
4346
- "private": false,
4347
- "remoteOp": true,
4348
- "skipWorkspace": true
4349
- },
4350
4315
  {
4351
4316
  "name": "pack <componentId> [scopePath]",
4352
4317
  "alias": "",
@@ -2236,7 +2236,33 @@ function MDXContent(_ref) {
2236
2236
  parentName: "p"
2237
2237
  }, "Description"), ": show dependents of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2238
2238
  parentName: "p"
2239
- }, "bit dependents <component-name>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "deprecate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2239
+ }, "bit dependents <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2240
+ parentName: "table"
2241
+ }, (0, _react2.mdx)("tr", {
2242
+ parentName: "thead"
2243
+ }, (0, _react2.mdx)("th", {
2244
+ parentName: "tr",
2245
+ "align": null
2246
+ }, (0, _react2.mdx)("strong", {
2247
+ parentName: "th"
2248
+ }, "Arg")), (0, _react2.mdx)("th", {
2249
+ parentName: "tr",
2250
+ "align": "center"
2251
+ }, (0, _react2.mdx)("strong", {
2252
+ parentName: "th"
2253
+ }, "Description")))), (0, _react2.mdx)("tbody", {
2254
+ parentName: "table"
2255
+ }, (0, _react2.mdx)("tr", {
2256
+ parentName: "tbody"
2257
+ }, (0, _react2.mdx)("td", {
2258
+ parentName: "tr",
2259
+ "align": null
2260
+ }, (0, _react2.mdx)("inlineCode", {
2261
+ parentName: "td"
2262
+ }, "component-name")), (0, _react2.mdx)("td", {
2263
+ parentName: "tr",
2264
+ "align": "center"
2265
+ }, "component name or component id")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "deprecate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2240
2266
  parentName: "p"
2241
2267
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
2242
2268
  parentName: "p"
@@ -7456,11 +7482,39 @@ function MDXContent(_ref) {
7456
7482
  parentName: "p"
7457
7483
  }), "\n", "if no ids are specified, all pending-merge components will be merged. (run \"bit status\" to list them).", (0, _react2.mdx)("br", {
7458
7484
  parentName: "p"
7459
- }), "\n", "optionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command.", (0, _react2.mdx)("br", {
7460
- parentName: "p"
7461
- }), "\n", "you can use a pattern for multiple ids, such as bit merge \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
7485
+ }), "\n", "optionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
7462
7486
  parentName: "p"
7463
- }, "bit merge [ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
7487
+ }, "bit merge [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
7488
+ parentName: "table"
7489
+ }, (0, _react2.mdx)("tr", {
7490
+ parentName: "thead"
7491
+ }, (0, _react2.mdx)("th", {
7492
+ parentName: "tr",
7493
+ "align": null
7494
+ }, (0, _react2.mdx)("strong", {
7495
+ parentName: "th"
7496
+ }, "Arg")), (0, _react2.mdx)("th", {
7497
+ parentName: "tr",
7498
+ "align": "center"
7499
+ }, (0, _react2.mdx)("strong", {
7500
+ parentName: "th"
7501
+ }, "Description")))), (0, _react2.mdx)("tbody", {
7502
+ parentName: "table"
7503
+ }, (0, _react2.mdx)("tr", {
7504
+ parentName: "tbody"
7505
+ }, (0, _react2.mdx)("td", {
7506
+ parentName: "tr",
7507
+ "align": null
7508
+ }, (0, _react2.mdx)("inlineCode", {
7509
+ parentName: "td"
7510
+ }, "component-pattern")), (0, _react2.mdx)("td", {
7511
+ parentName: "tr",
7512
+ "align": "center"
7513
+ }, "component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use ", (0, _react2.mdx)("inlineCode", {
7514
+ parentName: "td"
7515
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
7516
+ parentName: "td"
7517
+ }, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
7464
7518
  parentName: "table"
7465
7519
  }, (0, _react2.mdx)("tr", {
7466
7520
  parentName: "thead"
@@ -9373,35 +9427,7 @@ function MDXContent(_ref) {
9373
9427
  }, "-x")), (0, _react2.mdx)("td", {
9374
9428
  parentName: "tr",
9375
9429
  "align": null
9376
- }, "do not install packages of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope-config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9377
- parentName: "p"
9378
- }, "Description"), ": scope config management"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
9379
- parentName: "p"
9380
- }, "bit scope-config")), (0, _react2.mdx)("h3", null, "scope-config set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9381
- parentName: "p"
9382
- }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
9383
- parentName: "p"
9384
- }, "scope-config set <key> <val>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9385
- parentName: "p"
9386
- }, "Description"), ": set a scope configuration"), (0, _react2.mdx)("h3", null, "scope-config del"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9387
- parentName: "p"
9388
- }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
9389
- parentName: "p"
9390
- }, "scope-config del <key>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9391
- parentName: "p"
9392
- }, "Description"), ": delete given key from global configuration"), (0, _react2.mdx)("h3", null, "scope-config get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9393
- parentName: "p"
9394
- }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
9395
- parentName: "p"
9396
- }, "scope-config get <key>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9397
- parentName: "p"
9398
- }, "Description"), ": get a scope configuration"), (0, _react2.mdx)("h3", null, "scope-config list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9399
- parentName: "p"
9400
- }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
9401
- parentName: "p"
9402
- }, "scope-config list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9403
- parentName: "p"
9404
- }, "Description"), ": list all scope configuration(s)"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "server"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9430
+ }, "do not install packages of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "server"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
9405
9431
  parentName: "p"
9406
9432
  }, "Description"), ": EXPERIMENTAL. communicate with bit cli program via http requests"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
9407
9433
  parentName: "p"