@teambit/harmony.content.cli-reference 1.95.23 → 1.95.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli-reference.json +3007 -0
- package/cli-reference.mdx +62 -68
- package/dist/cli-reference.json +3007 -0
- package/dist/cli-reference.mdx.js +74 -52
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/tsconfig.json +29 -0
- package/package-tar/teambit-harmony.content.cli-reference-1.95.26.tgz +0 -0
- package/package.json +2 -2
- package/{preview-1653449228788.js → preview-1654745302834.js} +2 -2
- package/tsconfig.json +7 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.23.tgz +0 -0
|
@@ -0,0 +1,3007 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "init [path]",
|
|
4
|
+
"alias": "",
|
|
5
|
+
"options": [
|
|
6
|
+
[
|
|
7
|
+
"b",
|
|
8
|
+
"bare [name]",
|
|
9
|
+
"initialize an empty bit bare scope"
|
|
10
|
+
],
|
|
11
|
+
[
|
|
12
|
+
"s",
|
|
13
|
+
"shared <groupname>",
|
|
14
|
+
"add group write permissions to a scope properly"
|
|
15
|
+
],
|
|
16
|
+
[
|
|
17
|
+
"T",
|
|
18
|
+
"standalone",
|
|
19
|
+
"do not nest component store within .git directory and do not write config data inside package.json"
|
|
20
|
+
],
|
|
21
|
+
[
|
|
22
|
+
"r",
|
|
23
|
+
"reset",
|
|
24
|
+
"write missing or damaged Bit files"
|
|
25
|
+
],
|
|
26
|
+
[
|
|
27
|
+
"",
|
|
28
|
+
"reset-new",
|
|
29
|
+
"reset .bitmap file as if the components were newly added and remove all model data (objects)"
|
|
30
|
+
],
|
|
31
|
+
[
|
|
32
|
+
"",
|
|
33
|
+
"reset-hard",
|
|
34
|
+
"delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-start using Bit from scratch"
|
|
35
|
+
],
|
|
36
|
+
[
|
|
37
|
+
"d",
|
|
38
|
+
"default-directory <default-directory>",
|
|
39
|
+
"set up default directory to import components into"
|
|
40
|
+
],
|
|
41
|
+
[
|
|
42
|
+
"p",
|
|
43
|
+
"package-manager <package-manager>",
|
|
44
|
+
"set up package manager (npm or yarn)"
|
|
45
|
+
],
|
|
46
|
+
[
|
|
47
|
+
"f",
|
|
48
|
+
"force",
|
|
49
|
+
"force workspace initialization without clearing local objects"
|
|
50
|
+
],
|
|
51
|
+
[
|
|
52
|
+
"",
|
|
53
|
+
"harmony",
|
|
54
|
+
"DEPRECATED. no need for this flag. Harmony is the default now"
|
|
55
|
+
],
|
|
56
|
+
[
|
|
57
|
+
"I",
|
|
58
|
+
"interactive",
|
|
59
|
+
"EXPERIMENTAL. start an interactive process"
|
|
60
|
+
]
|
|
61
|
+
],
|
|
62
|
+
"description": "create or reinitialize an empty workspace",
|
|
63
|
+
"extendedDescription": "https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project",
|
|
64
|
+
"group": "start",
|
|
65
|
+
"private": false,
|
|
66
|
+
"skipWorkspace": true
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "list [remote-scope]",
|
|
70
|
+
"alias": "ls",
|
|
71
|
+
"options": [
|
|
72
|
+
[
|
|
73
|
+
"i",
|
|
74
|
+
"ids",
|
|
75
|
+
"show only component ids unformatted"
|
|
76
|
+
],
|
|
77
|
+
[
|
|
78
|
+
"s",
|
|
79
|
+
"scope",
|
|
80
|
+
"show only components stored in the local scope, including indirect dependencies"
|
|
81
|
+
],
|
|
82
|
+
[
|
|
83
|
+
"b",
|
|
84
|
+
"bare",
|
|
85
|
+
"DEPRECATED. use --raw instead"
|
|
86
|
+
],
|
|
87
|
+
[
|
|
88
|
+
"r",
|
|
89
|
+
"raw",
|
|
90
|
+
"show raw output (only components ids, no styling)"
|
|
91
|
+
],
|
|
92
|
+
[
|
|
93
|
+
"o",
|
|
94
|
+
"outdated",
|
|
95
|
+
"show latest versions from remotes"
|
|
96
|
+
],
|
|
97
|
+
[
|
|
98
|
+
"j",
|
|
99
|
+
"json",
|
|
100
|
+
"show the output in JSON format"
|
|
101
|
+
],
|
|
102
|
+
[
|
|
103
|
+
"n",
|
|
104
|
+
"namespace <string>",
|
|
105
|
+
"show only specified namespace by using wildcards"
|
|
106
|
+
]
|
|
107
|
+
],
|
|
108
|
+
"description": "list components on a workspace, local scope or a remote scope.",
|
|
109
|
+
"extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
|
|
110
|
+
"group": "discover",
|
|
111
|
+
"private": false,
|
|
112
|
+
"skipWorkspace": true
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "config",
|
|
116
|
+
"alias": "",
|
|
117
|
+
"options": [],
|
|
118
|
+
"description": "global config management",
|
|
119
|
+
"extendedDescription": "https://bit.dev/docs/config/bit-config",
|
|
120
|
+
"group": "general",
|
|
121
|
+
"private": false,
|
|
122
|
+
"commands": [
|
|
123
|
+
{
|
|
124
|
+
"name": "set <key> <val>",
|
|
125
|
+
"alias": "",
|
|
126
|
+
"options": [],
|
|
127
|
+
"description": "set a global configuration",
|
|
128
|
+
"extendedDescription": "",
|
|
129
|
+
"group": "ungrouped",
|
|
130
|
+
"private": false,
|
|
131
|
+
"skipWorkspace": true
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "del <key>",
|
|
135
|
+
"alias": "",
|
|
136
|
+
"options": [],
|
|
137
|
+
"description": "delete given key from global configuration",
|
|
138
|
+
"extendedDescription": "",
|
|
139
|
+
"group": "ungrouped",
|
|
140
|
+
"private": false
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"name": "get <key>",
|
|
144
|
+
"alias": "",
|
|
145
|
+
"options": [],
|
|
146
|
+
"description": "get a global configuration",
|
|
147
|
+
"extendedDescription": "",
|
|
148
|
+
"group": "ungrouped",
|
|
149
|
+
"private": false
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"name": "list",
|
|
153
|
+
"alias": "",
|
|
154
|
+
"options": [],
|
|
155
|
+
"description": "list all configuration(s)",
|
|
156
|
+
"extendedDescription": "",
|
|
157
|
+
"group": "ungrouped",
|
|
158
|
+
"private": false
|
|
159
|
+
}
|
|
160
|
+
]
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"name": "remote",
|
|
164
|
+
"alias": "",
|
|
165
|
+
"options": [
|
|
166
|
+
[
|
|
167
|
+
"g",
|
|
168
|
+
"global",
|
|
169
|
+
"see globally configured remotes"
|
|
170
|
+
]
|
|
171
|
+
],
|
|
172
|
+
"description": "manage set of tracked bit scope(s)",
|
|
173
|
+
"extendedDescription": "https://bit.dev/docs/scope/remote-scopes",
|
|
174
|
+
"group": "collaborate",
|
|
175
|
+
"private": false,
|
|
176
|
+
"commands": [
|
|
177
|
+
{
|
|
178
|
+
"name": "add <url>",
|
|
179
|
+
"alias": "",
|
|
180
|
+
"options": [
|
|
181
|
+
[
|
|
182
|
+
"g",
|
|
183
|
+
"global",
|
|
184
|
+
"configure a remote bit scope"
|
|
185
|
+
]
|
|
186
|
+
],
|
|
187
|
+
"description": "add a bare-scope as a remote",
|
|
188
|
+
"extendedDescription": "supported protocols are [file, http].\nfor example: \"http://localhost:3000\", \"file:///tmp/local-scope\"",
|
|
189
|
+
"group": "ungrouped",
|
|
190
|
+
"private": false
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "del <name>",
|
|
194
|
+
"alias": "",
|
|
195
|
+
"options": [
|
|
196
|
+
[
|
|
197
|
+
"g",
|
|
198
|
+
"global",
|
|
199
|
+
"remove a global configured remote scope"
|
|
200
|
+
]
|
|
201
|
+
],
|
|
202
|
+
"description": "remove a tracked bit remote",
|
|
203
|
+
"extendedDescription": "",
|
|
204
|
+
"group": "ungrouped",
|
|
205
|
+
"private": false
|
|
206
|
+
}
|
|
207
|
+
]
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"name": "cat-object <hash>",
|
|
211
|
+
"alias": "",
|
|
212
|
+
"options": [
|
|
213
|
+
[
|
|
214
|
+
"p",
|
|
215
|
+
"pretty",
|
|
216
|
+
"pretty print for the objects"
|
|
217
|
+
],
|
|
218
|
+
[
|
|
219
|
+
"s",
|
|
220
|
+
"stringify",
|
|
221
|
+
"JSON.stringify the object to see special characters, such as \"\n\""
|
|
222
|
+
],
|
|
223
|
+
[
|
|
224
|
+
"",
|
|
225
|
+
"headers",
|
|
226
|
+
"shows the headers only"
|
|
227
|
+
]
|
|
228
|
+
],
|
|
229
|
+
"description": "cat a bit object by hash",
|
|
230
|
+
"extendedDescription": "",
|
|
231
|
+
"group": "ungrouped",
|
|
232
|
+
"private": true
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "cat-component [id]",
|
|
236
|
+
"alias": "cmp",
|
|
237
|
+
"options": [
|
|
238
|
+
[
|
|
239
|
+
"j",
|
|
240
|
+
"json",
|
|
241
|
+
"json format"
|
|
242
|
+
]
|
|
243
|
+
],
|
|
244
|
+
"description": "cat a bit object by component-id",
|
|
245
|
+
"extendedDescription": "",
|
|
246
|
+
"group": "ungrouped",
|
|
247
|
+
"private": true
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"name": "cat-lane <id>",
|
|
251
|
+
"alias": "cl",
|
|
252
|
+
"options": [],
|
|
253
|
+
"description": "cat a bit object by lane-name",
|
|
254
|
+
"extendedDescription": "",
|
|
255
|
+
"group": "ungrouped",
|
|
256
|
+
"private": true
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "dependents <id>",
|
|
260
|
+
"alias": "",
|
|
261
|
+
"options": [],
|
|
262
|
+
"description": "EXPERIMENTAL. show dependents of the given component",
|
|
263
|
+
"extendedDescription": "",
|
|
264
|
+
"group": "info",
|
|
265
|
+
"private": false
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "dependencies <id>",
|
|
269
|
+
"alias": "",
|
|
270
|
+
"options": [
|
|
271
|
+
[
|
|
272
|
+
"d",
|
|
273
|
+
"debug",
|
|
274
|
+
"show the immediate dependencies and how their version was determined"
|
|
275
|
+
]
|
|
276
|
+
],
|
|
277
|
+
"description": "EXPERIMENTAL. show dependencies (direct and indirect) of the given component",
|
|
278
|
+
"extendedDescription": "",
|
|
279
|
+
"group": "info",
|
|
280
|
+
"private": false
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"name": "_log <path> <args>",
|
|
284
|
+
"alias": "",
|
|
285
|
+
"options": [],
|
|
286
|
+
"description": "show component logs",
|
|
287
|
+
"extendedDescription": "",
|
|
288
|
+
"group": "ungrouped",
|
|
289
|
+
"private": true,
|
|
290
|
+
"internal": true
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
"name": "_put <path> <args>",
|
|
294
|
+
"alias": "",
|
|
295
|
+
"options": [],
|
|
296
|
+
"description": "upload a component to a scope",
|
|
297
|
+
"extendedDescription": "",
|
|
298
|
+
"group": "ungrouped",
|
|
299
|
+
"private": true,
|
|
300
|
+
"internal": true
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"name": "_list <path> <args>",
|
|
304
|
+
"alias": "",
|
|
305
|
+
"options": [],
|
|
306
|
+
"description": "list scope components",
|
|
307
|
+
"extendedDescription": "",
|
|
308
|
+
"group": "ungrouped",
|
|
309
|
+
"private": true,
|
|
310
|
+
"internal": true
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"name": "_show <path> <args>",
|
|
314
|
+
"alias": "",
|
|
315
|
+
"options": [],
|
|
316
|
+
"description": "show a specific component on scope",
|
|
317
|
+
"extendedDescription": "",
|
|
318
|
+
"group": "ungrouped",
|
|
319
|
+
"private": true,
|
|
320
|
+
"internal": true
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "_graph <path> <args>",
|
|
324
|
+
"alias": "",
|
|
325
|
+
"options": [],
|
|
326
|
+
"description": "returns scope graph or sub-graph when component id is given",
|
|
327
|
+
"extendedDescription": "",
|
|
328
|
+
"group": "ungrouped",
|
|
329
|
+
"private": true,
|
|
330
|
+
"internal": true
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"name": "_fetch <path> <args>",
|
|
334
|
+
"alias": "",
|
|
335
|
+
"options": [
|
|
336
|
+
[
|
|
337
|
+
"",
|
|
338
|
+
"type <string>",
|
|
339
|
+
"ids type, options are: [\"component\", \"lane\", \"object\"]"
|
|
340
|
+
],
|
|
341
|
+
[
|
|
342
|
+
"n",
|
|
343
|
+
"no-dependencies",
|
|
344
|
+
"do not include component dependencies"
|
|
345
|
+
],
|
|
346
|
+
[
|
|
347
|
+
"",
|
|
348
|
+
"include-artifacts",
|
|
349
|
+
"include components artifacts objects"
|
|
350
|
+
]
|
|
351
|
+
],
|
|
352
|
+
"description": "fetch components(s) from a scope",
|
|
353
|
+
"extendedDescription": "",
|
|
354
|
+
"group": "ungrouped",
|
|
355
|
+
"private": true,
|
|
356
|
+
"internal": true
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "_action <path> <args>",
|
|
360
|
+
"alias": "",
|
|
361
|
+
"options": [],
|
|
362
|
+
"description": "execute a generic action",
|
|
363
|
+
"extendedDescription": "",
|
|
364
|
+
"group": "ungrouped",
|
|
365
|
+
"private": true,
|
|
366
|
+
"internal": true
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "inject-conf [id]",
|
|
370
|
+
"alias": "",
|
|
371
|
+
"options": [
|
|
372
|
+
[
|
|
373
|
+
"f",
|
|
374
|
+
"force",
|
|
375
|
+
"force injecting even if there are config files changes"
|
|
376
|
+
]
|
|
377
|
+
],
|
|
378
|
+
"description": "injecting components configuration",
|
|
379
|
+
"extendedDescription": "",
|
|
380
|
+
"group": "ungrouped",
|
|
381
|
+
"private": true
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
"name": "_scope <path> <args>",
|
|
385
|
+
"alias": "",
|
|
386
|
+
"options": [],
|
|
387
|
+
"description": "describe a scope",
|
|
388
|
+
"extendedDescription": "",
|
|
389
|
+
"group": "ungrouped",
|
|
390
|
+
"private": true,
|
|
391
|
+
"internal": true
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"name": "ci-update <id> [scopePath]",
|
|
395
|
+
"alias": "",
|
|
396
|
+
"options": [
|
|
397
|
+
[
|
|
398
|
+
"d",
|
|
399
|
+
"directory [file]",
|
|
400
|
+
"directory to run ci-update"
|
|
401
|
+
],
|
|
402
|
+
[
|
|
403
|
+
"k",
|
|
404
|
+
"keep",
|
|
405
|
+
"keep test environment after run (default false)"
|
|
406
|
+
],
|
|
407
|
+
[
|
|
408
|
+
"c",
|
|
409
|
+
"no-cache",
|
|
410
|
+
"ignore component cache when creating dist file"
|
|
411
|
+
],
|
|
412
|
+
[
|
|
413
|
+
"o",
|
|
414
|
+
"output [file]",
|
|
415
|
+
"save ci results to file system"
|
|
416
|
+
]
|
|
417
|
+
],
|
|
418
|
+
"description": "run an update for build and test of a certain bit-component",
|
|
419
|
+
"extendedDescription": "",
|
|
420
|
+
"group": "ungrouped",
|
|
421
|
+
"private": true
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "cat-scope [scopePath]",
|
|
425
|
+
"alias": "",
|
|
426
|
+
"options": [
|
|
427
|
+
[
|
|
428
|
+
"f",
|
|
429
|
+
"full",
|
|
430
|
+
"show all of the objects in the scope (except \"Source\")"
|
|
431
|
+
],
|
|
432
|
+
[
|
|
433
|
+
"j",
|
|
434
|
+
"json",
|
|
435
|
+
"print the objects as a json format"
|
|
436
|
+
],
|
|
437
|
+
[
|
|
438
|
+
"e",
|
|
439
|
+
"json-extra",
|
|
440
|
+
"add hash and object type to the json"
|
|
441
|
+
]
|
|
442
|
+
],
|
|
443
|
+
"description": "cat a scope and show all the contents",
|
|
444
|
+
"extendedDescription": "",
|
|
445
|
+
"group": "ungrouped",
|
|
446
|
+
"private": true
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "scope-config",
|
|
450
|
+
"alias": "",
|
|
451
|
+
"options": [],
|
|
452
|
+
"description": "scope config management",
|
|
453
|
+
"extendedDescription": "",
|
|
454
|
+
"group": "general",
|
|
455
|
+
"private": false,
|
|
456
|
+
"commands": [
|
|
457
|
+
{
|
|
458
|
+
"name": "set <key> <val>",
|
|
459
|
+
"alias": "",
|
|
460
|
+
"options": [],
|
|
461
|
+
"description": "set a scope configuration",
|
|
462
|
+
"extendedDescription": "",
|
|
463
|
+
"group": "ungrouped",
|
|
464
|
+
"private": true
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"name": "del <key>",
|
|
468
|
+
"alias": "",
|
|
469
|
+
"options": [],
|
|
470
|
+
"description": "delete given key from global configuration",
|
|
471
|
+
"extendedDescription": "",
|
|
472
|
+
"group": "ungrouped",
|
|
473
|
+
"private": false
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "get <key>",
|
|
477
|
+
"alias": "",
|
|
478
|
+
"options": [],
|
|
479
|
+
"description": "get a scope configuration",
|
|
480
|
+
"extendedDescription": "",
|
|
481
|
+
"group": "ungrouped",
|
|
482
|
+
"private": true
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"name": "list",
|
|
486
|
+
"alias": "",
|
|
487
|
+
"options": [],
|
|
488
|
+
"description": "list all scope configuration(s)",
|
|
489
|
+
"extendedDescription": "",
|
|
490
|
+
"group": "ungrouped",
|
|
491
|
+
"private": false
|
|
492
|
+
}
|
|
493
|
+
]
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "dependency-status [mainFile...]",
|
|
497
|
+
"alias": "",
|
|
498
|
+
"options": [],
|
|
499
|
+
"description": "returns the status of the dependency status of bit map against bit dependencies",
|
|
500
|
+
"extendedDescription": "",
|
|
501
|
+
"group": "ungrouped",
|
|
502
|
+
"private": true
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "add [path...]",
|
|
506
|
+
"alias": "a",
|
|
507
|
+
"options": [
|
|
508
|
+
[
|
|
509
|
+
"i",
|
|
510
|
+
"id <name>",
|
|
511
|
+
"manually set component id"
|
|
512
|
+
],
|
|
513
|
+
[
|
|
514
|
+
"m",
|
|
515
|
+
"main <file>",
|
|
516
|
+
"define entry point for the components"
|
|
517
|
+
],
|
|
518
|
+
[
|
|
519
|
+
"t",
|
|
520
|
+
"tests <file>/\"<file>,<file>\"",
|
|
521
|
+
"specify test files to track. use quotation marks to list files or use a glob pattern"
|
|
522
|
+
],
|
|
523
|
+
[
|
|
524
|
+
"n",
|
|
525
|
+
"namespace <namespace>",
|
|
526
|
+
"organize component in a namespace"
|
|
527
|
+
],
|
|
528
|
+
[
|
|
529
|
+
"e",
|
|
530
|
+
"exclude <file>/\"<file>,<file>\"",
|
|
531
|
+
"exclude file from being tracked. use quotation marks to list files or use a glob pattern"
|
|
532
|
+
],
|
|
533
|
+
[
|
|
534
|
+
"o",
|
|
535
|
+
"override <boolean>",
|
|
536
|
+
"override existing component if exists (default = false)"
|
|
537
|
+
],
|
|
538
|
+
[
|
|
539
|
+
"s",
|
|
540
|
+
"scope <string>",
|
|
541
|
+
"sets the component's scope-name. if not entered, the default-scope will be used"
|
|
542
|
+
]
|
|
543
|
+
],
|
|
544
|
+
"description": "Add any subset of files to be tracked as a component(s).",
|
|
545
|
+
"extendedDescription": "all flags support glob patterns and {PARENT} {FILE_NAME} annotations\n https://bit.dev/docs/components/adding-components",
|
|
546
|
+
"group": "development",
|
|
547
|
+
"private": false
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "untrack [ids...]",
|
|
551
|
+
"alias": "u",
|
|
552
|
+
"options": [
|
|
553
|
+
[
|
|
554
|
+
"a",
|
|
555
|
+
"all",
|
|
556
|
+
"revert add for all tracked components"
|
|
557
|
+
]
|
|
558
|
+
],
|
|
559
|
+
"description": "DEPRECATED (use \"bit remove\" instead). untrack a new component(s)\n https://legacy-docs.bit.dev/docs/add-and-isolate-components#untracking-components\n you can use a pattern for multiple ids, such as bit untrack \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
560
|
+
"extendedDescription": "",
|
|
561
|
+
"group": "ungrouped",
|
|
562
|
+
"private": true
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "untag [id] [version]",
|
|
566
|
+
"alias": "",
|
|
567
|
+
"options": [
|
|
568
|
+
[
|
|
569
|
+
"a",
|
|
570
|
+
"all",
|
|
571
|
+
"revert tag for all tagged components"
|
|
572
|
+
],
|
|
573
|
+
[
|
|
574
|
+
"",
|
|
575
|
+
"soft",
|
|
576
|
+
"harmony - revert only soft-tags (components tagged with --soft flag)"
|
|
577
|
+
],
|
|
578
|
+
[
|
|
579
|
+
"f",
|
|
580
|
+
"force",
|
|
581
|
+
"revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
|
|
582
|
+
]
|
|
583
|
+
],
|
|
584
|
+
"description": "revert versions tagged for component(s)",
|
|
585
|
+
"extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
586
|
+
"group": "development",
|
|
587
|
+
"private": false
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
"name": "move <existing-dir> <new-dir>",
|
|
591
|
+
"alias": "mv",
|
|
592
|
+
"options": [
|
|
593
|
+
[
|
|
594
|
+
"c",
|
|
595
|
+
"component",
|
|
596
|
+
"move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
|
|
597
|
+
]
|
|
598
|
+
],
|
|
599
|
+
"description": "move a component to a different filesystem path",
|
|
600
|
+
"extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
|
|
601
|
+
"group": "development",
|
|
602
|
+
"private": false
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"name": "remove <ids...>",
|
|
606
|
+
"alias": "rm",
|
|
607
|
+
"options": [
|
|
608
|
+
[
|
|
609
|
+
"r",
|
|
610
|
+
"remote",
|
|
611
|
+
"remove a component from a remote scope"
|
|
612
|
+
],
|
|
613
|
+
[
|
|
614
|
+
"t",
|
|
615
|
+
"track",
|
|
616
|
+
"keep tracking component (default = false)"
|
|
617
|
+
],
|
|
618
|
+
[
|
|
619
|
+
"d",
|
|
620
|
+
"delete-files",
|
|
621
|
+
"DEPRECATED (this is now the default). delete local component files"
|
|
622
|
+
],
|
|
623
|
+
[
|
|
624
|
+
"",
|
|
625
|
+
"keep-files",
|
|
626
|
+
"keep component files (just untrack the component)"
|
|
627
|
+
],
|
|
628
|
+
[
|
|
629
|
+
"f",
|
|
630
|
+
"force",
|
|
631
|
+
"removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
|
|
632
|
+
],
|
|
633
|
+
[
|
|
634
|
+
"s",
|
|
635
|
+
"silent",
|
|
636
|
+
"skip confirmation"
|
|
637
|
+
]
|
|
638
|
+
],
|
|
639
|
+
"description": "remove component(s) from your workspace, or a remote scope",
|
|
640
|
+
"extendedDescription": "https://bit.dev/docs/components/removing-components\nyou can use a pattern for multiple ids, such as bit remove \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
641
|
+
"group": "collaborate",
|
|
642
|
+
"private": false,
|
|
643
|
+
"skipWorkspace": true
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "_delete <path> <args>",
|
|
647
|
+
"alias": "",
|
|
648
|
+
"options": [],
|
|
649
|
+
"description": "remove a component from a scope",
|
|
650
|
+
"extendedDescription": "",
|
|
651
|
+
"group": "ungrouped",
|
|
652
|
+
"private": true,
|
|
653
|
+
"internal": true
|
|
654
|
+
},
|
|
655
|
+
{
|
|
656
|
+
"name": "_deprecate <path> <args>",
|
|
657
|
+
"alias": "",
|
|
658
|
+
"options": [],
|
|
659
|
+
"description": "deprecate a component from a scope",
|
|
660
|
+
"extendedDescription": "",
|
|
661
|
+
"group": "ungrouped",
|
|
662
|
+
"private": true,
|
|
663
|
+
"internal": true
|
|
664
|
+
},
|
|
665
|
+
{
|
|
666
|
+
"name": "_undeprecate <path> <args>",
|
|
667
|
+
"alias": "",
|
|
668
|
+
"options": [],
|
|
669
|
+
"description": "undeprecate a component from a scope",
|
|
670
|
+
"extendedDescription": "",
|
|
671
|
+
"group": "ungrouped",
|
|
672
|
+
"private": true,
|
|
673
|
+
"internal": true
|
|
674
|
+
},
|
|
675
|
+
{
|
|
676
|
+
"name": "_latest <path> <args>",
|
|
677
|
+
"alias": "",
|
|
678
|
+
"options": [],
|
|
679
|
+
"description": "latest version numbers of given components",
|
|
680
|
+
"extendedDescription": "",
|
|
681
|
+
"group": "ungrouped",
|
|
682
|
+
"private": true,
|
|
683
|
+
"internal": true
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
"name": "checkout [values...]",
|
|
687
|
+
"alias": "U",
|
|
688
|
+
"options": [
|
|
689
|
+
[
|
|
690
|
+
"i",
|
|
691
|
+
"interactive-merge",
|
|
692
|
+
"when a component is modified and the merge process found conflicts, display options to resolve them"
|
|
693
|
+
],
|
|
694
|
+
[
|
|
695
|
+
"o",
|
|
696
|
+
"ours",
|
|
697
|
+
"in case of a conflict, override the used version with the current modification"
|
|
698
|
+
],
|
|
699
|
+
[
|
|
700
|
+
"t",
|
|
701
|
+
"theirs",
|
|
702
|
+
"in case of a conflict, override the current modification with the specified version"
|
|
703
|
+
],
|
|
704
|
+
[
|
|
705
|
+
"m",
|
|
706
|
+
"manual",
|
|
707
|
+
"in case of a conflict, leave the files with a conflict state to resolve them manually later"
|
|
708
|
+
],
|
|
709
|
+
[
|
|
710
|
+
"r",
|
|
711
|
+
"reset",
|
|
712
|
+
"remove local changes"
|
|
713
|
+
],
|
|
714
|
+
[
|
|
715
|
+
"a",
|
|
716
|
+
"all",
|
|
717
|
+
"all components"
|
|
718
|
+
],
|
|
719
|
+
[
|
|
720
|
+
"v",
|
|
721
|
+
"verbose",
|
|
722
|
+
"showing verbose output for inspection"
|
|
723
|
+
],
|
|
724
|
+
[
|
|
725
|
+
"",
|
|
726
|
+
"skip-npm-install",
|
|
727
|
+
"DEPRECATED. use \"--skip-dependency-installation\" instead"
|
|
728
|
+
],
|
|
729
|
+
[
|
|
730
|
+
"",
|
|
731
|
+
"skip-dependency-installation",
|
|
732
|
+
"do not install packages of the imported components"
|
|
733
|
+
],
|
|
734
|
+
[
|
|
735
|
+
"",
|
|
736
|
+
"ignore-package-json",
|
|
737
|
+
"do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)"
|
|
738
|
+
],
|
|
739
|
+
[
|
|
740
|
+
"",
|
|
741
|
+
"conf [path]",
|
|
742
|
+
"write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)"
|
|
743
|
+
],
|
|
744
|
+
[
|
|
745
|
+
"",
|
|
746
|
+
"ignore-dist",
|
|
747
|
+
"do not write dist files (when exist)"
|
|
748
|
+
]
|
|
749
|
+
],
|
|
750
|
+
"description": "switch between component versions or remove local changes",
|
|
751
|
+
"extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout latest` => checkout all components to their latest versions\n `bit checkout latest [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
752
|
+
"group": "development",
|
|
753
|
+
"private": false
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
"name": "diff [values...]",
|
|
757
|
+
"alias": "",
|
|
758
|
+
"options": [
|
|
759
|
+
[
|
|
760
|
+
"v",
|
|
761
|
+
"verbose",
|
|
762
|
+
"show a more verbose output when possible"
|
|
763
|
+
],
|
|
764
|
+
[
|
|
765
|
+
"t",
|
|
766
|
+
"table",
|
|
767
|
+
"show tables instead of plain text for dependencies diff"
|
|
768
|
+
]
|
|
769
|
+
],
|
|
770
|
+
"description": "show diff between components files",
|
|
771
|
+
"extendedDescription": "bit diff => compare all modified components to their model version\n bit diff [ids...] => compare the specified components against their modified states\n bit diff [id] [version] => compare the specified version to used or modified files\n bit diff [id] [version] [to_version] => compare the specified version files to to_version files\n you can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
772
|
+
"group": "development",
|
|
773
|
+
"private": false
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "login",
|
|
777
|
+
"alias": "",
|
|
778
|
+
"options": [
|
|
779
|
+
[
|
|
780
|
+
"p",
|
|
781
|
+
"port <port>",
|
|
782
|
+
"port number to open for localhost server (default 8085)"
|
|
783
|
+
],
|
|
784
|
+
[
|
|
785
|
+
"",
|
|
786
|
+
"suppress-browser-launch",
|
|
787
|
+
"do not open a browser for authentication"
|
|
788
|
+
],
|
|
789
|
+
[
|
|
790
|
+
"",
|
|
791
|
+
"npmrc-path <path>",
|
|
792
|
+
"path to npmrc file to configure bit.cloud registry"
|
|
793
|
+
],
|
|
794
|
+
[
|
|
795
|
+
"",
|
|
796
|
+
"skip-registry-config",
|
|
797
|
+
"don't configure bit.cloud registry"
|
|
798
|
+
],
|
|
799
|
+
[
|
|
800
|
+
"",
|
|
801
|
+
"machine-name <string>",
|
|
802
|
+
"specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token)"
|
|
803
|
+
]
|
|
804
|
+
],
|
|
805
|
+
"description": "log the CLI into Bit Cloud",
|
|
806
|
+
"extendedDescription": "",
|
|
807
|
+
"group": "general",
|
|
808
|
+
"private": false,
|
|
809
|
+
"skipWorkspace": true
|
|
810
|
+
},
|
|
811
|
+
{
|
|
812
|
+
"name": "logout",
|
|
813
|
+
"alias": "",
|
|
814
|
+
"options": [],
|
|
815
|
+
"description": "log the CLI out of Bit",
|
|
816
|
+
"extendedDescription": "",
|
|
817
|
+
"group": "general",
|
|
818
|
+
"private": false
|
|
819
|
+
},
|
|
820
|
+
{
|
|
821
|
+
"name": "migrate [scopePath]",
|
|
822
|
+
"alias": "",
|
|
823
|
+
"options": [
|
|
824
|
+
[
|
|
825
|
+
"v",
|
|
826
|
+
"verbose",
|
|
827
|
+
"showing logs for the migration process"
|
|
828
|
+
],
|
|
829
|
+
[
|
|
830
|
+
"h",
|
|
831
|
+
"harmony",
|
|
832
|
+
"migrate workspace from legacy to Harmony"
|
|
833
|
+
]
|
|
834
|
+
],
|
|
835
|
+
"description": "migrate scope to the current version",
|
|
836
|
+
"extendedDescription": "",
|
|
837
|
+
"group": "ungrouped",
|
|
838
|
+
"private": true
|
|
839
|
+
},
|
|
840
|
+
{
|
|
841
|
+
"name": "doctor [diagnosis-name]",
|
|
842
|
+
"alias": "",
|
|
843
|
+
"options": [
|
|
844
|
+
[
|
|
845
|
+
"j",
|
|
846
|
+
"json",
|
|
847
|
+
"return diagnoses in json format"
|
|
848
|
+
],
|
|
849
|
+
[
|
|
850
|
+
"",
|
|
851
|
+
"list",
|
|
852
|
+
"list all available diagnoses"
|
|
853
|
+
],
|
|
854
|
+
[
|
|
855
|
+
"s",
|
|
856
|
+
"save [filePath]",
|
|
857
|
+
"save diagnoses to a file"
|
|
858
|
+
]
|
|
859
|
+
],
|
|
860
|
+
"description": "diagnose a bit workspace",
|
|
861
|
+
"extendedDescription": "",
|
|
862
|
+
"group": "general",
|
|
863
|
+
"private": false
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"name": "graph [id]",
|
|
867
|
+
"alias": "",
|
|
868
|
+
"options": [
|
|
869
|
+
[
|
|
870
|
+
"i",
|
|
871
|
+
"image <image>",
|
|
872
|
+
"image path. use one of the following extensions: [gif, png, svg, pdf]"
|
|
873
|
+
],
|
|
874
|
+
[
|
|
875
|
+
"r",
|
|
876
|
+
"remote [remoteName]",
|
|
877
|
+
"remote name (name is optional, leave empty when id is specified)"
|
|
878
|
+
],
|
|
879
|
+
[
|
|
880
|
+
"",
|
|
881
|
+
"all-versions",
|
|
882
|
+
"enter all components versions into the graph, not only latest"
|
|
883
|
+
],
|
|
884
|
+
[
|
|
885
|
+
"",
|
|
886
|
+
"layout <name>",
|
|
887
|
+
"GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
|
|
888
|
+
]
|
|
889
|
+
],
|
|
890
|
+
"description": "EXPERIMENTAL. generate an image file with the dependencies graph",
|
|
891
|
+
"extendedDescription": "",
|
|
892
|
+
"group": "discover",
|
|
893
|
+
"private": false
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "fetch [ids...]",
|
|
897
|
+
"alias": "",
|
|
898
|
+
"options": [
|
|
899
|
+
[
|
|
900
|
+
"l",
|
|
901
|
+
"lanes",
|
|
902
|
+
"EXPERIMENTAL. fetch component objects from lanes. note, it does not save the remote lanes objects locally, only the refs"
|
|
903
|
+
],
|
|
904
|
+
[
|
|
905
|
+
"c",
|
|
906
|
+
"components",
|
|
907
|
+
"fetch components"
|
|
908
|
+
],
|
|
909
|
+
[
|
|
910
|
+
"j",
|
|
911
|
+
"json",
|
|
912
|
+
"return the output as JSON"
|
|
913
|
+
],
|
|
914
|
+
[
|
|
915
|
+
"",
|
|
916
|
+
"from-original-scopes",
|
|
917
|
+
"fetch indirect dependencies from their original scope as opposed to from their dependents"
|
|
918
|
+
]
|
|
919
|
+
],
|
|
920
|
+
"description": "fetch remote objects and store locally",
|
|
921
|
+
"extendedDescription": "for lanes, use \"/\" as a separator between the remote and the lane name, e.g. teambit.ui/fix-button",
|
|
922
|
+
"group": "ungrouped",
|
|
923
|
+
"private": true
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "run-action <action-name> <remote> <options>",
|
|
927
|
+
"alias": "",
|
|
928
|
+
"options": [],
|
|
929
|
+
"description": "run an action on a remote",
|
|
930
|
+
"extendedDescription": "",
|
|
931
|
+
"group": "ungrouped",
|
|
932
|
+
"private": true
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "_lanes <path> <args>",
|
|
936
|
+
"alias": "",
|
|
937
|
+
"options": [
|
|
938
|
+
[
|
|
939
|
+
"",
|
|
940
|
+
"merge-data",
|
|
941
|
+
"collect merge data"
|
|
942
|
+
]
|
|
943
|
+
],
|
|
944
|
+
"description": "list lanes",
|
|
945
|
+
"extendedDescription": "",
|
|
946
|
+
"group": "ungrouped",
|
|
947
|
+
"private": true,
|
|
948
|
+
"internal": true
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "completion",
|
|
952
|
+
"alias": "",
|
|
953
|
+
"options": [],
|
|
954
|
+
"description": "enable bash/zsh-completion shortcuts for commands and options",
|
|
955
|
+
"extendedDescription": "",
|
|
956
|
+
"group": "general",
|
|
957
|
+
"private": false
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
"name": "cli",
|
|
961
|
+
"alias": "",
|
|
962
|
+
"options": [],
|
|
963
|
+
"description": "EXPERIMENTAL. enters bit cli program and generates commands list",
|
|
964
|
+
"extendedDescription": "",
|
|
965
|
+
"group": "general",
|
|
966
|
+
"private": false,
|
|
967
|
+
"commands": [
|
|
968
|
+
{
|
|
969
|
+
"name": "generate",
|
|
970
|
+
"alias": "",
|
|
971
|
+
"options": [
|
|
972
|
+
[
|
|
973
|
+
"",
|
|
974
|
+
"metadata",
|
|
975
|
+
"metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands"
|
|
976
|
+
],
|
|
977
|
+
[
|
|
978
|
+
"j",
|
|
979
|
+
"json",
|
|
980
|
+
"output the commands info as JSON"
|
|
981
|
+
]
|
|
982
|
+
],
|
|
983
|
+
"description": "EXPERIMENTAL. generate an .md file with all commands details",
|
|
984
|
+
"extendedDescription": "",
|
|
985
|
+
"group": "general",
|
|
986
|
+
"private": false
|
|
987
|
+
}
|
|
988
|
+
]
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
"name": "help",
|
|
992
|
+
"alias": "$0",
|
|
993
|
+
"options": [],
|
|
994
|
+
"description": "shows help",
|
|
995
|
+
"extendedDescription": "",
|
|
996
|
+
"group": "general",
|
|
997
|
+
"private": false
|
|
998
|
+
},
|
|
999
|
+
{
|
|
1000
|
+
"name": "use [ids...]",
|
|
1001
|
+
"alias": "",
|
|
1002
|
+
"options": [],
|
|
1003
|
+
"description": "set up aspects in the workspace/scope config",
|
|
1004
|
+
"extendedDescription": "",
|
|
1005
|
+
"group": "collaborate",
|
|
1006
|
+
"private": false,
|
|
1007
|
+
"remoteOp": true
|
|
1008
|
+
},
|
|
1009
|
+
{
|
|
1010
|
+
"name": "show <id>",
|
|
1011
|
+
"alias": "",
|
|
1012
|
+
"options": [
|
|
1013
|
+
[
|
|
1014
|
+
"j",
|
|
1015
|
+
"json",
|
|
1016
|
+
"return the component data in json format"
|
|
1017
|
+
],
|
|
1018
|
+
[
|
|
1019
|
+
"l",
|
|
1020
|
+
"legacy",
|
|
1021
|
+
"use the legacy bit show."
|
|
1022
|
+
],
|
|
1023
|
+
[
|
|
1024
|
+
"r",
|
|
1025
|
+
"remote",
|
|
1026
|
+
"show a remote component"
|
|
1027
|
+
],
|
|
1028
|
+
[
|
|
1029
|
+
"c",
|
|
1030
|
+
"compare",
|
|
1031
|
+
"compare current file system component to latest tagged component [default=latest]. only works in legacy."
|
|
1032
|
+
]
|
|
1033
|
+
],
|
|
1034
|
+
"description": "show a component",
|
|
1035
|
+
"extendedDescription": "",
|
|
1036
|
+
"group": "info",
|
|
1037
|
+
"private": false
|
|
1038
|
+
},
|
|
1039
|
+
{
|
|
1040
|
+
"name": "globals",
|
|
1041
|
+
"alias": "",
|
|
1042
|
+
"options": [
|
|
1043
|
+
[
|
|
1044
|
+
"j",
|
|
1045
|
+
"json",
|
|
1046
|
+
"json format"
|
|
1047
|
+
]
|
|
1048
|
+
],
|
|
1049
|
+
"description": "list all globals",
|
|
1050
|
+
"extendedDescription": "",
|
|
1051
|
+
"group": "workspace",
|
|
1052
|
+
"private": false
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"name": "envs",
|
|
1056
|
+
"alias": "env",
|
|
1057
|
+
"options": [],
|
|
1058
|
+
"description": "list all components envs",
|
|
1059
|
+
"extendedDescription": "",
|
|
1060
|
+
"group": "development",
|
|
1061
|
+
"private": false,
|
|
1062
|
+
"commands": [
|
|
1063
|
+
{
|
|
1064
|
+
"name": "list",
|
|
1065
|
+
"alias": "",
|
|
1066
|
+
"options": [],
|
|
1067
|
+
"description": "list all envs available in the workspace",
|
|
1068
|
+
"extendedDescription": "",
|
|
1069
|
+
"group": "development",
|
|
1070
|
+
"private": false
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
"name": "get <name>",
|
|
1074
|
+
"alias": "",
|
|
1075
|
+
"options": [],
|
|
1076
|
+
"description": "show component's env details",
|
|
1077
|
+
"extendedDescription": "",
|
|
1078
|
+
"group": "development",
|
|
1079
|
+
"private": false
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
"name": "set <pattern> <env>",
|
|
1083
|
+
"options": [],
|
|
1084
|
+
"description": "set an environment for component(s)",
|
|
1085
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit env set \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
1086
|
+
"group": "development"
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "unset <component>",
|
|
1090
|
+
"options": [],
|
|
1091
|
+
"description": "unset an environment from component(s)",
|
|
1092
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
1093
|
+
"group": "development"
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
"name": "replace <old-env> <new-env>",
|
|
1097
|
+
"options": [],
|
|
1098
|
+
"description": "replace an existing env with another env for all components using the old env",
|
|
1099
|
+
"group": "development"
|
|
1100
|
+
}
|
|
1101
|
+
]
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "start [type] [pattern]",
|
|
1105
|
+
"alias": "c",
|
|
1106
|
+
"options": [
|
|
1107
|
+
[
|
|
1108
|
+
"d",
|
|
1109
|
+
"dev",
|
|
1110
|
+
"start UI server in dev mode."
|
|
1111
|
+
],
|
|
1112
|
+
[
|
|
1113
|
+
"p",
|
|
1114
|
+
"port [number]",
|
|
1115
|
+
"port of the UI server."
|
|
1116
|
+
],
|
|
1117
|
+
[
|
|
1118
|
+
"r",
|
|
1119
|
+
"rebuild",
|
|
1120
|
+
"rebuild the UI"
|
|
1121
|
+
],
|
|
1122
|
+
[
|
|
1123
|
+
"v",
|
|
1124
|
+
"verbose",
|
|
1125
|
+
"showing verbose output for inspection and prints stack trace"
|
|
1126
|
+
],
|
|
1127
|
+
[
|
|
1128
|
+
"",
|
|
1129
|
+
"no-browser",
|
|
1130
|
+
"do not automatically open browser when ready"
|
|
1131
|
+
],
|
|
1132
|
+
[
|
|
1133
|
+
"",
|
|
1134
|
+
"skip-compilation",
|
|
1135
|
+
"skip the auto-compilation before starting the web-server"
|
|
1136
|
+
]
|
|
1137
|
+
],
|
|
1138
|
+
"description": "Start a dev environment for a workspace or a specific component",
|
|
1139
|
+
"extendedDescription": "",
|
|
1140
|
+
"group": "development",
|
|
1141
|
+
"private": false
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"name": "ui-build [type]",
|
|
1145
|
+
"alias": "c",
|
|
1146
|
+
"options": [],
|
|
1147
|
+
"description": "build production assets for deployment.",
|
|
1148
|
+
"extendedDescription": "",
|
|
1149
|
+
"group": "development",
|
|
1150
|
+
"private": false
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"name": "scope <sub-command>",
|
|
1154
|
+
"alias": "",
|
|
1155
|
+
"options": [],
|
|
1156
|
+
"description": "EXPERIMENTAL. manage scope-name",
|
|
1157
|
+
"extendedDescription": "",
|
|
1158
|
+
"group": "development",
|
|
1159
|
+
"private": false,
|
|
1160
|
+
"commands": [
|
|
1161
|
+
{
|
|
1162
|
+
"name": "set <scope-name> [pattern]",
|
|
1163
|
+
"options": [],
|
|
1164
|
+
"description": "set the default-scope",
|
|
1165
|
+
"extendedDescription": "set a new scope in the workspace.jsonc.\nif \"pattern\" is provided, the default-scope will be set to the new components matching the criteria.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
1166
|
+
"group": "development"
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"name": "rename <old-name> <new-name>",
|
|
1170
|
+
"options": [
|
|
1171
|
+
[
|
|
1172
|
+
"r",
|
|
1173
|
+
"refactor",
|
|
1174
|
+
"change the source code of all components using the original scope-name with the new scope-name"
|
|
1175
|
+
]
|
|
1176
|
+
],
|
|
1177
|
+
"description": "rename a scope for components using the old-name, optionally change the dependencies source-code",
|
|
1178
|
+
"group": "development"
|
|
1179
|
+
},
|
|
1180
|
+
{
|
|
1181
|
+
"name": "fork <original-scope> <new-scope>",
|
|
1182
|
+
"options": [],
|
|
1183
|
+
"description": "fork all components of the original-scope and refactor the source-code to use the new package names",
|
|
1184
|
+
"group": "development"
|
|
1185
|
+
}
|
|
1186
|
+
]
|
|
1187
|
+
},
|
|
1188
|
+
{
|
|
1189
|
+
"name": "install [packages...]",
|
|
1190
|
+
"alias": "in",
|
|
1191
|
+
"options": [
|
|
1192
|
+
[
|
|
1193
|
+
"v",
|
|
1194
|
+
"variants <variants>",
|
|
1195
|
+
"add packages to specific variants"
|
|
1196
|
+
],
|
|
1197
|
+
[
|
|
1198
|
+
"t",
|
|
1199
|
+
"type [lifecycleType]",
|
|
1200
|
+
"\"runtime\" (default) or \"peer\" (dev is not a valid option)"
|
|
1201
|
+
],
|
|
1202
|
+
[
|
|
1203
|
+
"u",
|
|
1204
|
+
"update-existing [updateExisting]",
|
|
1205
|
+
"update existing dependencies version and types"
|
|
1206
|
+
],
|
|
1207
|
+
[
|
|
1208
|
+
"",
|
|
1209
|
+
"save-prefix [savePrefix]",
|
|
1210
|
+
"set the prefix to use when adding dependency to workspace.jsonc"
|
|
1211
|
+
],
|
|
1212
|
+
[
|
|
1213
|
+
"",
|
|
1214
|
+
"skip-dedupe [skipDedupe]",
|
|
1215
|
+
"do not dedupe dependencies on installation"
|
|
1216
|
+
],
|
|
1217
|
+
[
|
|
1218
|
+
"",
|
|
1219
|
+
"skip-import [skipImport]",
|
|
1220
|
+
"do not import bit objects post installation"
|
|
1221
|
+
],
|
|
1222
|
+
[
|
|
1223
|
+
"",
|
|
1224
|
+
"add-missing-peers [addMissingPeers]",
|
|
1225
|
+
"install all missing peer dependencies"
|
|
1226
|
+
]
|
|
1227
|
+
],
|
|
1228
|
+
"description": "install development workspace dependencies",
|
|
1229
|
+
"extendedDescription": "",
|
|
1230
|
+
"group": "development",
|
|
1231
|
+
"private": false
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"name": "update",
|
|
1235
|
+
"alias": "up",
|
|
1236
|
+
"options": [
|
|
1237
|
+
[
|
|
1238
|
+
"y",
|
|
1239
|
+
"yes",
|
|
1240
|
+
"automatically update all outdated packages"
|
|
1241
|
+
]
|
|
1242
|
+
],
|
|
1243
|
+
"description": "update dependencies",
|
|
1244
|
+
"extendedDescription": "",
|
|
1245
|
+
"group": "development",
|
|
1246
|
+
"private": false
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "uninstall [packages...]",
|
|
1250
|
+
"alias": "un",
|
|
1251
|
+
"options": [],
|
|
1252
|
+
"description": "uninstall dependencies",
|
|
1253
|
+
"extendedDescription": "",
|
|
1254
|
+
"group": "development",
|
|
1255
|
+
"private": false
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"name": "eject-conf <pattern>",
|
|
1259
|
+
"alias": "",
|
|
1260
|
+
"options": [
|
|
1261
|
+
[
|
|
1262
|
+
"p",
|
|
1263
|
+
"propagate",
|
|
1264
|
+
"mark propagate true in the config file"
|
|
1265
|
+
],
|
|
1266
|
+
[
|
|
1267
|
+
"o",
|
|
1268
|
+
"override",
|
|
1269
|
+
"override file if exist"
|
|
1270
|
+
]
|
|
1271
|
+
],
|
|
1272
|
+
"description": "eject components configuration (create a `component.json` file)",
|
|
1273
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
1274
|
+
"group": "development",
|
|
1275
|
+
"private": false
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
"name": "capsule <sub-command>",
|
|
1279
|
+
"alias": "",
|
|
1280
|
+
"options": [],
|
|
1281
|
+
"description": "manage capsules",
|
|
1282
|
+
"extendedDescription": "a capsule is a directory contains the component code, isolated from the workspace.\nnormally, capsules are created during the build process, the component files are copied and the packages are installed\nvia the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for\nother users after publishing/exporting them.",
|
|
1283
|
+
"group": "capsules",
|
|
1284
|
+
"private": false,
|
|
1285
|
+
"commands": [
|
|
1286
|
+
{
|
|
1287
|
+
"name": "list",
|
|
1288
|
+
"alias": "",
|
|
1289
|
+
"options": [
|
|
1290
|
+
[
|
|
1291
|
+
"j",
|
|
1292
|
+
"json",
|
|
1293
|
+
"json format"
|
|
1294
|
+
]
|
|
1295
|
+
],
|
|
1296
|
+
"description": "list all capsules",
|
|
1297
|
+
"extendedDescription": "",
|
|
1298
|
+
"group": "capsules",
|
|
1299
|
+
"private": false
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
"name": "create [componentIds...]",
|
|
1303
|
+
"alias": "",
|
|
1304
|
+
"options": [
|
|
1305
|
+
[
|
|
1306
|
+
"b",
|
|
1307
|
+
"base-dir <name>",
|
|
1308
|
+
"set base dir of all capsules (hashed to create the base dir inside the root dir - host path by default)"
|
|
1309
|
+
],
|
|
1310
|
+
[
|
|
1311
|
+
"r",
|
|
1312
|
+
"root-base-dir <name>",
|
|
1313
|
+
"set root base dir of all capsules (absolute path to use as root dir)"
|
|
1314
|
+
],
|
|
1315
|
+
[
|
|
1316
|
+
"a",
|
|
1317
|
+
"always-new",
|
|
1318
|
+
"create new environment for capsule"
|
|
1319
|
+
],
|
|
1320
|
+
[
|
|
1321
|
+
"s",
|
|
1322
|
+
"seeders-only",
|
|
1323
|
+
"create capsules for the seeders only (not for the entire graph)"
|
|
1324
|
+
],
|
|
1325
|
+
[
|
|
1326
|
+
"i",
|
|
1327
|
+
"id <name>",
|
|
1328
|
+
"reuse capsule of certain name"
|
|
1329
|
+
],
|
|
1330
|
+
[
|
|
1331
|
+
"j",
|
|
1332
|
+
"json",
|
|
1333
|
+
"json format"
|
|
1334
|
+
],
|
|
1335
|
+
[
|
|
1336
|
+
"d",
|
|
1337
|
+
"install-packages",
|
|
1338
|
+
"install packages by the package-manager"
|
|
1339
|
+
],
|
|
1340
|
+
[
|
|
1341
|
+
"p",
|
|
1342
|
+
"package-manager <name>",
|
|
1343
|
+
"npm, yarn or pnpm, default to npm"
|
|
1344
|
+
]
|
|
1345
|
+
],
|
|
1346
|
+
"description": "create capsules",
|
|
1347
|
+
"extendedDescription": "",
|
|
1348
|
+
"group": "capsules",
|
|
1349
|
+
"private": false
|
|
1350
|
+
},
|
|
1351
|
+
{
|
|
1352
|
+
"name": "delete",
|
|
1353
|
+
"alias": "",
|
|
1354
|
+
"options": [
|
|
1355
|
+
[
|
|
1356
|
+
"",
|
|
1357
|
+
"scope-aspects",
|
|
1358
|
+
"delete scope-aspects capsules"
|
|
1359
|
+
],
|
|
1360
|
+
[
|
|
1361
|
+
"a",
|
|
1362
|
+
"all",
|
|
1363
|
+
"delete all capsules for all workspaces and scopes"
|
|
1364
|
+
]
|
|
1365
|
+
],
|
|
1366
|
+
"description": "delete capsules",
|
|
1367
|
+
"extendedDescription": "with no args, only workspace's capsules are deleted",
|
|
1368
|
+
"group": "capsules",
|
|
1369
|
+
"private": false
|
|
1370
|
+
}
|
|
1371
|
+
]
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"name": "watch",
|
|
1375
|
+
"alias": "",
|
|
1376
|
+
"options": [
|
|
1377
|
+
[
|
|
1378
|
+
"v",
|
|
1379
|
+
"verbose",
|
|
1380
|
+
"showing npm verbose output for inspection and prints stack trace"
|
|
1381
|
+
],
|
|
1382
|
+
[
|
|
1383
|
+
"",
|
|
1384
|
+
"skip-pre-compilation",
|
|
1385
|
+
"skip the compilation step before starting to watch"
|
|
1386
|
+
],
|
|
1387
|
+
[
|
|
1388
|
+
"t",
|
|
1389
|
+
"check-types [string]",
|
|
1390
|
+
"EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project"
|
|
1391
|
+
]
|
|
1392
|
+
],
|
|
1393
|
+
"description": "watch a set of components",
|
|
1394
|
+
"extendedDescription": "",
|
|
1395
|
+
"group": "development",
|
|
1396
|
+
"private": false
|
|
1397
|
+
},
|
|
1398
|
+
{
|
|
1399
|
+
"name": "link [ids...]",
|
|
1400
|
+
"alias": "",
|
|
1401
|
+
"options": [
|
|
1402
|
+
[
|
|
1403
|
+
"j",
|
|
1404
|
+
"json",
|
|
1405
|
+
"return the output as JSON"
|
|
1406
|
+
],
|
|
1407
|
+
[
|
|
1408
|
+
"",
|
|
1409
|
+
"verbose",
|
|
1410
|
+
"verbose output"
|
|
1411
|
+
],
|
|
1412
|
+
[
|
|
1413
|
+
"r",
|
|
1414
|
+
"rewire",
|
|
1415
|
+
"Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
|
|
1416
|
+
],
|
|
1417
|
+
[
|
|
1418
|
+
"",
|
|
1419
|
+
"target <dir>",
|
|
1420
|
+
"EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
|
|
1421
|
+
],
|
|
1422
|
+
[
|
|
1423
|
+
"",
|
|
1424
|
+
"skip-fetching-objects",
|
|
1425
|
+
"skip fetch missing objects from remotes before linking"
|
|
1426
|
+
]
|
|
1427
|
+
],
|
|
1428
|
+
"description": "link components and core aspects",
|
|
1429
|
+
"extendedDescription": "https://bit.dev/docs/workspace/component-links",
|
|
1430
|
+
"group": "development",
|
|
1431
|
+
"private": false
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
"name": "pattern <pattern>",
|
|
1435
|
+
"alias": "",
|
|
1436
|
+
"options": [
|
|
1437
|
+
[
|
|
1438
|
+
"j",
|
|
1439
|
+
"json",
|
|
1440
|
+
"return the output as JSON"
|
|
1441
|
+
]
|
|
1442
|
+
],
|
|
1443
|
+
"description": "list the component ids matching the given pattern",
|
|
1444
|
+
"extendedDescription": "",
|
|
1445
|
+
"group": "development",
|
|
1446
|
+
"private": false
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
"name": "import [ids...]",
|
|
1450
|
+
"alias": "",
|
|
1451
|
+
"options": [
|
|
1452
|
+
[
|
|
1453
|
+
"p",
|
|
1454
|
+
"path <path>",
|
|
1455
|
+
"import components into a specific directory"
|
|
1456
|
+
],
|
|
1457
|
+
[
|
|
1458
|
+
"o",
|
|
1459
|
+
"objects",
|
|
1460
|
+
"import components objects only, don't write the components to the file system. This is a default behavior for import with no id"
|
|
1461
|
+
],
|
|
1462
|
+
[
|
|
1463
|
+
"d",
|
|
1464
|
+
"display-dependencies",
|
|
1465
|
+
"display the imported dependencies"
|
|
1466
|
+
],
|
|
1467
|
+
[
|
|
1468
|
+
"O",
|
|
1469
|
+
"override",
|
|
1470
|
+
"override local changes"
|
|
1471
|
+
],
|
|
1472
|
+
[
|
|
1473
|
+
"v",
|
|
1474
|
+
"verbose",
|
|
1475
|
+
"showing verbose output for inspection"
|
|
1476
|
+
],
|
|
1477
|
+
[
|
|
1478
|
+
"j",
|
|
1479
|
+
"json",
|
|
1480
|
+
"return the output as JSON"
|
|
1481
|
+
],
|
|
1482
|
+
[
|
|
1483
|
+
"",
|
|
1484
|
+
"conf",
|
|
1485
|
+
"write the configuration file (component.json) of the component (harmony components only)"
|
|
1486
|
+
],
|
|
1487
|
+
[
|
|
1488
|
+
"",
|
|
1489
|
+
"skip-npm-install",
|
|
1490
|
+
"DEPRECATED. use \"--skip-dependency-installation\" instead"
|
|
1491
|
+
],
|
|
1492
|
+
[
|
|
1493
|
+
"",
|
|
1494
|
+
"skip-dependency-installation",
|
|
1495
|
+
"do not install packages of the imported components"
|
|
1496
|
+
],
|
|
1497
|
+
[
|
|
1498
|
+
"m",
|
|
1499
|
+
"merge [strategy]",
|
|
1500
|
+
"merge local changes with the imported version. strategy should be \"theirs\", \"ours\" or \"manual\""
|
|
1501
|
+
],
|
|
1502
|
+
[
|
|
1503
|
+
"",
|
|
1504
|
+
"dependencies",
|
|
1505
|
+
"EXPERIMENTAL. import all dependencies and write them to the workspace"
|
|
1506
|
+
],
|
|
1507
|
+
[
|
|
1508
|
+
"",
|
|
1509
|
+
"dependents",
|
|
1510
|
+
"EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag"
|
|
1511
|
+
],
|
|
1512
|
+
[
|
|
1513
|
+
"",
|
|
1514
|
+
"save-in-lane",
|
|
1515
|
+
"EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)"
|
|
1516
|
+
],
|
|
1517
|
+
[
|
|
1518
|
+
"",
|
|
1519
|
+
"all-history",
|
|
1520
|
+
"relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
|
|
1521
|
+
]
|
|
1522
|
+
],
|
|
1523
|
+
"description": "import components into your workspace",
|
|
1524
|
+
"extendedDescription": "https://bit.dev/docs/components/importing-components\nyou can use a pattern for multiple ids, such as bit import \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1525
|
+
"group": "collaborate",
|
|
1526
|
+
"private": false,
|
|
1527
|
+
"remoteOp": true
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"name": "create <templateName> <componentNames...>",
|
|
1531
|
+
"alias": "",
|
|
1532
|
+
"options": [
|
|
1533
|
+
[
|
|
1534
|
+
"n",
|
|
1535
|
+
"namespace <string>",
|
|
1536
|
+
"sets the component's namespace and nested dirs inside the scope"
|
|
1537
|
+
],
|
|
1538
|
+
[
|
|
1539
|
+
"s",
|
|
1540
|
+
"scope <string>",
|
|
1541
|
+
"sets the component's scope-name. if not entered, the default-scope will be used"
|
|
1542
|
+
],
|
|
1543
|
+
[
|
|
1544
|
+
"a",
|
|
1545
|
+
"aspect <string>",
|
|
1546
|
+
"aspect-id of the template. helpful when multiple aspects use the same template name"
|
|
1547
|
+
],
|
|
1548
|
+
[
|
|
1549
|
+
"p",
|
|
1550
|
+
"path <string>",
|
|
1551
|
+
"relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
|
|
1552
|
+
],
|
|
1553
|
+
[
|
|
1554
|
+
"e",
|
|
1555
|
+
"env <string>",
|
|
1556
|
+
"set the component's environment. (overrides the env from variants and the template)"
|
|
1557
|
+
]
|
|
1558
|
+
],
|
|
1559
|
+
"description": "create a new component from a template",
|
|
1560
|
+
"extendedDescription": "",
|
|
1561
|
+
"group": "development",
|
|
1562
|
+
"private": false
|
|
1563
|
+
},
|
|
1564
|
+
{
|
|
1565
|
+
"name": "templates",
|
|
1566
|
+
"alias": "",
|
|
1567
|
+
"options": [
|
|
1568
|
+
[
|
|
1569
|
+
"s",
|
|
1570
|
+
"show-all",
|
|
1571
|
+
"show hidden templates"
|
|
1572
|
+
]
|
|
1573
|
+
],
|
|
1574
|
+
"description": "list templates for \"bit create\" and \"bit new\"",
|
|
1575
|
+
"extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
|
|
1576
|
+
"group": "development",
|
|
1577
|
+
"private": false
|
|
1578
|
+
},
|
|
1579
|
+
{
|
|
1580
|
+
"name": "new <templateName> <workspaceName>",
|
|
1581
|
+
"alias": "",
|
|
1582
|
+
"options": [
|
|
1583
|
+
[
|
|
1584
|
+
"a",
|
|
1585
|
+
"aspect <string>",
|
|
1586
|
+
"aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
|
|
1587
|
+
],
|
|
1588
|
+
[
|
|
1589
|
+
"d",
|
|
1590
|
+
"default-scope <string>",
|
|
1591
|
+
"set defaultScope in the new workspace.jsonc"
|
|
1592
|
+
],
|
|
1593
|
+
[
|
|
1594
|
+
"",
|
|
1595
|
+
"standalone",
|
|
1596
|
+
"DEPRECATED. use --skip-git instead"
|
|
1597
|
+
],
|
|
1598
|
+
[
|
|
1599
|
+
"s",
|
|
1600
|
+
"skip-git",
|
|
1601
|
+
"skip generation of Git repository"
|
|
1602
|
+
],
|
|
1603
|
+
[
|
|
1604
|
+
"e",
|
|
1605
|
+
"empty",
|
|
1606
|
+
"empty workspace with no components (relevant for templates that add components by default)"
|
|
1607
|
+
],
|
|
1608
|
+
[
|
|
1609
|
+
"",
|
|
1610
|
+
"load-from <string>",
|
|
1611
|
+
"path to the workspace containing the template. helpful during a development of a workspace-template"
|
|
1612
|
+
]
|
|
1613
|
+
],
|
|
1614
|
+
"description": "Create a new workspace from a template",
|
|
1615
|
+
"extendedDescription": "",
|
|
1616
|
+
"group": "start",
|
|
1617
|
+
"private": false
|
|
1618
|
+
},
|
|
1619
|
+
{
|
|
1620
|
+
"name": "build [pattern]",
|
|
1621
|
+
"alias": "",
|
|
1622
|
+
"options": [
|
|
1623
|
+
[
|
|
1624
|
+
"a",
|
|
1625
|
+
"all",
|
|
1626
|
+
"build all components, not only modified and new"
|
|
1627
|
+
],
|
|
1628
|
+
[
|
|
1629
|
+
"d",
|
|
1630
|
+
"dev",
|
|
1631
|
+
"run the pipeline in dev mode"
|
|
1632
|
+
],
|
|
1633
|
+
[
|
|
1634
|
+
"",
|
|
1635
|
+
"install",
|
|
1636
|
+
"install core aspects in capsules"
|
|
1637
|
+
],
|
|
1638
|
+
[
|
|
1639
|
+
"",
|
|
1640
|
+
"reuse-capsules",
|
|
1641
|
+
"avoid deleting the capsules root-dir before starting the build"
|
|
1642
|
+
],
|
|
1643
|
+
[
|
|
1644
|
+
"",
|
|
1645
|
+
"tasks <string>",
|
|
1646
|
+
"build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes.\nspecify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"
|
|
1647
|
+
],
|
|
1648
|
+
[
|
|
1649
|
+
"",
|
|
1650
|
+
"cache-packages-on-capsule-root",
|
|
1651
|
+
"set the package-manager cache on the capsule root"
|
|
1652
|
+
],
|
|
1653
|
+
[
|
|
1654
|
+
"",
|
|
1655
|
+
"list-tasks <string>",
|
|
1656
|
+
"list tasks of an env or a component-id for each one of the pipelines: build, tag and snap"
|
|
1657
|
+
]
|
|
1658
|
+
],
|
|
1659
|
+
"description": "run set of tasks for build",
|
|
1660
|
+
"extendedDescription": "",
|
|
1661
|
+
"group": "development",
|
|
1662
|
+
"private": false
|
|
1663
|
+
},
|
|
1664
|
+
{
|
|
1665
|
+
"name": "artifacts <pattern...>",
|
|
1666
|
+
"alias": "",
|
|
1667
|
+
"options": [
|
|
1668
|
+
[
|
|
1669
|
+
"",
|
|
1670
|
+
"aspect <aspect-id>",
|
|
1671
|
+
"show/download only artifacts generated by this aspect-id"
|
|
1672
|
+
],
|
|
1673
|
+
[
|
|
1674
|
+
"",
|
|
1675
|
+
"task <task-id>",
|
|
1676
|
+
"show/download only artifacts generated by this task-id"
|
|
1677
|
+
],
|
|
1678
|
+
[
|
|
1679
|
+
"",
|
|
1680
|
+
"files <glob>",
|
|
1681
|
+
"show/download only artifacts matching the given files or the glob pattern (wrap glob patterns in quotes)"
|
|
1682
|
+
],
|
|
1683
|
+
[
|
|
1684
|
+
"",
|
|
1685
|
+
"out-dir <string>",
|
|
1686
|
+
"download the files to the specified dir"
|
|
1687
|
+
]
|
|
1688
|
+
],
|
|
1689
|
+
"description": "EXPERIMENTAL. list and download components artifacts",
|
|
1690
|
+
"extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
|
|
1691
|
+
"group": "development",
|
|
1692
|
+
"private": false
|
|
1693
|
+
},
|
|
1694
|
+
{
|
|
1695
|
+
"name": "pack <componentId> [scopePath]",
|
|
1696
|
+
"alias": "",
|
|
1697
|
+
"options": [
|
|
1698
|
+
[
|
|
1699
|
+
"d",
|
|
1700
|
+
"out-dir <out-dir>",
|
|
1701
|
+
"directory to put the result tar file"
|
|
1702
|
+
],
|
|
1703
|
+
[
|
|
1704
|
+
"o",
|
|
1705
|
+
"override",
|
|
1706
|
+
"override existing pack file"
|
|
1707
|
+
],
|
|
1708
|
+
[
|
|
1709
|
+
"k",
|
|
1710
|
+
"keep",
|
|
1711
|
+
"should keep isolated environment [default = false]"
|
|
1712
|
+
],
|
|
1713
|
+
[
|
|
1714
|
+
"p",
|
|
1715
|
+
"prefix",
|
|
1716
|
+
"keep custom (binding) prefix"
|
|
1717
|
+
],
|
|
1718
|
+
[
|
|
1719
|
+
"j",
|
|
1720
|
+
"json",
|
|
1721
|
+
"return the output as JSON"
|
|
1722
|
+
]
|
|
1723
|
+
],
|
|
1724
|
+
"description": "create tar for npm publish",
|
|
1725
|
+
"extendedDescription": "",
|
|
1726
|
+
"group": "collaborate",
|
|
1727
|
+
"private": false
|
|
1728
|
+
},
|
|
1729
|
+
{
|
|
1730
|
+
"name": "publish <componentId>",
|
|
1731
|
+
"alias": "",
|
|
1732
|
+
"options": [
|
|
1733
|
+
[
|
|
1734
|
+
"d",
|
|
1735
|
+
"dry-run",
|
|
1736
|
+
"npm publish --dry-run"
|
|
1737
|
+
],
|
|
1738
|
+
[
|
|
1739
|
+
"",
|
|
1740
|
+
"allow-staged",
|
|
1741
|
+
"allow publish components that were not exported yet (not recommended)"
|
|
1742
|
+
],
|
|
1743
|
+
[
|
|
1744
|
+
"j",
|
|
1745
|
+
"json",
|
|
1746
|
+
"return the output as JSON"
|
|
1747
|
+
]
|
|
1748
|
+
],
|
|
1749
|
+
"description": "publish components to npm (npm publish)",
|
|
1750
|
+
"extendedDescription": "",
|
|
1751
|
+
"group": "collaborate",
|
|
1752
|
+
"private": true
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "refactor <sub-command>",
|
|
1756
|
+
"alias": "",
|
|
1757
|
+
"options": [],
|
|
1758
|
+
"description": "EXPERIMENTAL. source code refactoring / codemod",
|
|
1759
|
+
"extendedDescription": "",
|
|
1760
|
+
"group": "development",
|
|
1761
|
+
"private": false,
|
|
1762
|
+
"commands": [
|
|
1763
|
+
{
|
|
1764
|
+
"name": "dependency-name <old-id> <new-id>",
|
|
1765
|
+
"alias": "",
|
|
1766
|
+
"options": [],
|
|
1767
|
+
"description": "replace the dependency's old package-name with a new one in the code",
|
|
1768
|
+
"extendedDescription": "the `<old-id>` and `<new-id>` arguments can be either a component-id or a package-name.",
|
|
1769
|
+
"group": "development",
|
|
1770
|
+
"private": false
|
|
1771
|
+
}
|
|
1772
|
+
]
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"name": "component-issues",
|
|
1776
|
+
"alias": "",
|
|
1777
|
+
"options": [
|
|
1778
|
+
[
|
|
1779
|
+
"j",
|
|
1780
|
+
"json",
|
|
1781
|
+
"json format"
|
|
1782
|
+
]
|
|
1783
|
+
],
|
|
1784
|
+
"description": "list available component-issues",
|
|
1785
|
+
"extendedDescription": "",
|
|
1786
|
+
"group": "development",
|
|
1787
|
+
"private": false
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
"name": "insights [names...]",
|
|
1791
|
+
"alias": "",
|
|
1792
|
+
"options": [
|
|
1793
|
+
[
|
|
1794
|
+
"l",
|
|
1795
|
+
"list",
|
|
1796
|
+
"list all insights"
|
|
1797
|
+
],
|
|
1798
|
+
[
|
|
1799
|
+
"j",
|
|
1800
|
+
"json",
|
|
1801
|
+
"return the insights in json format"
|
|
1802
|
+
]
|
|
1803
|
+
],
|
|
1804
|
+
"description": "Insights on component graph",
|
|
1805
|
+
"extendedDescription": "",
|
|
1806
|
+
"group": "development",
|
|
1807
|
+
"private": true
|
|
1808
|
+
},
|
|
1809
|
+
{
|
|
1810
|
+
"name": "tag [id...]",
|
|
1811
|
+
"alias": "t",
|
|
1812
|
+
"options": [
|
|
1813
|
+
[
|
|
1814
|
+
"m",
|
|
1815
|
+
"message <message>",
|
|
1816
|
+
"log message describing the user changes"
|
|
1817
|
+
],
|
|
1818
|
+
[
|
|
1819
|
+
"",
|
|
1820
|
+
"unmodified",
|
|
1821
|
+
"include unmodified components (by default, only new and modified components are tagged)"
|
|
1822
|
+
],
|
|
1823
|
+
[
|
|
1824
|
+
"",
|
|
1825
|
+
"editor [editor]",
|
|
1826
|
+
"EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim"
|
|
1827
|
+
],
|
|
1828
|
+
[
|
|
1829
|
+
"v",
|
|
1830
|
+
"ver <version>",
|
|
1831
|
+
"tag with the given version"
|
|
1832
|
+
],
|
|
1833
|
+
[
|
|
1834
|
+
"p",
|
|
1835
|
+
"patch",
|
|
1836
|
+
"increment the patch version number"
|
|
1837
|
+
],
|
|
1838
|
+
[
|
|
1839
|
+
"",
|
|
1840
|
+
"minor",
|
|
1841
|
+
"increment the minor version number"
|
|
1842
|
+
],
|
|
1843
|
+
[
|
|
1844
|
+
"",
|
|
1845
|
+
"major",
|
|
1846
|
+
"increment the major version number"
|
|
1847
|
+
],
|
|
1848
|
+
[
|
|
1849
|
+
"",
|
|
1850
|
+
"snapped",
|
|
1851
|
+
"tag components that their head is a snap (not a tag)"
|
|
1852
|
+
],
|
|
1853
|
+
[
|
|
1854
|
+
"",
|
|
1855
|
+
"pre-release [identifier]",
|
|
1856
|
+
"EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)"
|
|
1857
|
+
],
|
|
1858
|
+
[
|
|
1859
|
+
"",
|
|
1860
|
+
"skip-tests",
|
|
1861
|
+
"skip running component tests during tag process"
|
|
1862
|
+
],
|
|
1863
|
+
[
|
|
1864
|
+
"",
|
|
1865
|
+
"skip-auto-tag",
|
|
1866
|
+
"skip auto tagging dependents"
|
|
1867
|
+
],
|
|
1868
|
+
[
|
|
1869
|
+
"",
|
|
1870
|
+
"soft",
|
|
1871
|
+
"do not persist. only keep note of the changes to be made"
|
|
1872
|
+
],
|
|
1873
|
+
[
|
|
1874
|
+
"",
|
|
1875
|
+
"persist",
|
|
1876
|
+
"persist the changes generated by --soft tag"
|
|
1877
|
+
],
|
|
1878
|
+
[
|
|
1879
|
+
"",
|
|
1880
|
+
"disable-tag-pipeline",
|
|
1881
|
+
"skip the tag pipeline to avoid publishing the components"
|
|
1882
|
+
],
|
|
1883
|
+
[
|
|
1884
|
+
"",
|
|
1885
|
+
"force-deploy",
|
|
1886
|
+
"run the tag pipeline although the build failed"
|
|
1887
|
+
],
|
|
1888
|
+
[
|
|
1889
|
+
"",
|
|
1890
|
+
"increment-by <number>",
|
|
1891
|
+
"(default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3."
|
|
1892
|
+
],
|
|
1893
|
+
[
|
|
1894
|
+
"i",
|
|
1895
|
+
"ignore-issues [issues]",
|
|
1896
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
1897
|
+
],
|
|
1898
|
+
[
|
|
1899
|
+
"I",
|
|
1900
|
+
"ignore-newest-version",
|
|
1901
|
+
"ignore existing of newer versions (default = false)"
|
|
1902
|
+
],
|
|
1903
|
+
[
|
|
1904
|
+
"b",
|
|
1905
|
+
"build",
|
|
1906
|
+
"EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag"
|
|
1907
|
+
],
|
|
1908
|
+
[
|
|
1909
|
+
"a",
|
|
1910
|
+
"all [version]",
|
|
1911
|
+
"DEPRECATED (not needed anymore, it is the default now). tag all new and modified components"
|
|
1912
|
+
],
|
|
1913
|
+
[
|
|
1914
|
+
"s",
|
|
1915
|
+
"scope [version]",
|
|
1916
|
+
"DEPRECATED (use \"--unmodified\" instead). tag all components of the current scope"
|
|
1917
|
+
],
|
|
1918
|
+
[
|
|
1919
|
+
"f",
|
|
1920
|
+
"force",
|
|
1921
|
+
"DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-tag even if tests are failing and even when component has not changed"
|
|
1922
|
+
],
|
|
1923
|
+
[
|
|
1924
|
+
"",
|
|
1925
|
+
"disable-deploy-pipeline",
|
|
1926
|
+
"DEPRECATED. use --disable-tag-pipeline instead"
|
|
1927
|
+
]
|
|
1928
|
+
],
|
|
1929
|
+
"description": "record component changes and lock versions",
|
|
1930
|
+
"extendedDescription": "if no ids are provided, it will tag all new and modified components.\nif component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags\nyou can use a pattern for multiple ids, such as bit tag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1931
|
+
"group": "development",
|
|
1932
|
+
"private": false,
|
|
1933
|
+
"remoteOp": true
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"name": "snap [id]",
|
|
1937
|
+
"alias": "",
|
|
1938
|
+
"options": [
|
|
1939
|
+
[
|
|
1940
|
+
"m",
|
|
1941
|
+
"message <message>",
|
|
1942
|
+
"log message describing the user changes"
|
|
1943
|
+
],
|
|
1944
|
+
[
|
|
1945
|
+
"",
|
|
1946
|
+
"unmodified",
|
|
1947
|
+
"include unmodified components (by default, only new and modified components are snapped)"
|
|
1948
|
+
],
|
|
1949
|
+
[
|
|
1950
|
+
"",
|
|
1951
|
+
"build",
|
|
1952
|
+
"Harmony only. run the pipeline build and complete the tag"
|
|
1953
|
+
],
|
|
1954
|
+
[
|
|
1955
|
+
"",
|
|
1956
|
+
"skip-tests",
|
|
1957
|
+
"skip running component tests during snap process"
|
|
1958
|
+
],
|
|
1959
|
+
[
|
|
1960
|
+
"",
|
|
1961
|
+
"skip-auto-snap",
|
|
1962
|
+
"skip auto snapping dependents"
|
|
1963
|
+
],
|
|
1964
|
+
[
|
|
1965
|
+
"",
|
|
1966
|
+
"disable-snap-pipeline",
|
|
1967
|
+
"skip the snap pipeline"
|
|
1968
|
+
],
|
|
1969
|
+
[
|
|
1970
|
+
"",
|
|
1971
|
+
"force-deploy",
|
|
1972
|
+
"Harmony only. run the deploy pipeline although the build failed"
|
|
1973
|
+
],
|
|
1974
|
+
[
|
|
1975
|
+
"i",
|
|
1976
|
+
"ignore-issues [issues]",
|
|
1977
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
1978
|
+
],
|
|
1979
|
+
[
|
|
1980
|
+
"a",
|
|
1981
|
+
"all",
|
|
1982
|
+
"DEPRECATED (not needed anymore, it is the default now). snap all new and modified components"
|
|
1983
|
+
],
|
|
1984
|
+
[
|
|
1985
|
+
"f",
|
|
1986
|
+
"force",
|
|
1987
|
+
"DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
|
|
1988
|
+
]
|
|
1989
|
+
],
|
|
1990
|
+
"description": "record component changes.\nhttps://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1991
|
+
"extendedDescription": "",
|
|
1992
|
+
"group": "ungrouped",
|
|
1993
|
+
"private": true
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"name": "merge [values...]",
|
|
1997
|
+
"alias": "",
|
|
1998
|
+
"options": [
|
|
1999
|
+
[
|
|
2000
|
+
"",
|
|
2001
|
+
"ours",
|
|
2002
|
+
"in case of a conflict, override the used version with the current modification"
|
|
2003
|
+
],
|
|
2004
|
+
[
|
|
2005
|
+
"",
|
|
2006
|
+
"theirs",
|
|
2007
|
+
"in case of a conflict, override the current modification with the specified version"
|
|
2008
|
+
],
|
|
2009
|
+
[
|
|
2010
|
+
"",
|
|
2011
|
+
"manual",
|
|
2012
|
+
"in case of a conflict, leave the files with a conflict state to resolve them manually later"
|
|
2013
|
+
],
|
|
2014
|
+
[
|
|
2015
|
+
"",
|
|
2016
|
+
"abort",
|
|
2017
|
+
"EXPERIMENTAL. in case of an unresolved merge, revert to the state before the merge began"
|
|
2018
|
+
],
|
|
2019
|
+
[
|
|
2020
|
+
"",
|
|
2021
|
+
"resolve",
|
|
2022
|
+
"EXPERIMENTAL. mark an unresolved merge as resolved and create a new snap with the changes"
|
|
2023
|
+
],
|
|
2024
|
+
[
|
|
2025
|
+
"",
|
|
2026
|
+
"no-snap",
|
|
2027
|
+
"EXPERIMENTAL. do not auto snap in case the merge completed without conflicts"
|
|
2028
|
+
],
|
|
2029
|
+
[
|
|
2030
|
+
"",
|
|
2031
|
+
"build",
|
|
2032
|
+
"in case of snap during the merge, run the build-pipeline (similar to bit snap --build)"
|
|
2033
|
+
],
|
|
2034
|
+
[
|
|
2035
|
+
"m",
|
|
2036
|
+
"message <message>",
|
|
2037
|
+
"EXPERIMENTAL. override the default message for the auto snap"
|
|
2038
|
+
]
|
|
2039
|
+
],
|
|
2040
|
+
"description": "merge changes of different component versions",
|
|
2041
|
+
"extendedDescription": "merge changes of different component versions\n `bit merge <version> [ids...]` => merge changes of the given version into the checked out version\n `bit merge [ids...]` => EXPERIMENTAL. merge changes of the remote head into local, optionally use '--abort' or '--resolve'\n you can use a pattern for multiple ids, such as bit merge 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
2042
|
+
"group": "development",
|
|
2043
|
+
"private": false
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
"name": "status",
|
|
2047
|
+
"alias": "s",
|
|
2048
|
+
"options": [
|
|
2049
|
+
[
|
|
2050
|
+
"j",
|
|
2051
|
+
"json",
|
|
2052
|
+
"return a json version of the component"
|
|
2053
|
+
],
|
|
2054
|
+
[
|
|
2055
|
+
"",
|
|
2056
|
+
"strict",
|
|
2057
|
+
"in case issues found, exit with code 1"
|
|
2058
|
+
]
|
|
2059
|
+
],
|
|
2060
|
+
"description": "show the working area component(s) status",
|
|
2061
|
+
"extendedDescription": "https://bit.dev/docs/workspace/workspace-status",
|
|
2062
|
+
"group": "development",
|
|
2063
|
+
"private": false
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"name": "compile [component...]",
|
|
2067
|
+
"alias": "",
|
|
2068
|
+
"options": [
|
|
2069
|
+
[
|
|
2070
|
+
"c",
|
|
2071
|
+
"changed",
|
|
2072
|
+
"compile only new and modified components"
|
|
2073
|
+
],
|
|
2074
|
+
[
|
|
2075
|
+
"v",
|
|
2076
|
+
"verbose",
|
|
2077
|
+
"show more data, such as, dist paths"
|
|
2078
|
+
],
|
|
2079
|
+
[
|
|
2080
|
+
"j",
|
|
2081
|
+
"json",
|
|
2082
|
+
"return the compile results in json format"
|
|
2083
|
+
],
|
|
2084
|
+
[
|
|
2085
|
+
"d",
|
|
2086
|
+
"delete-dist-dir",
|
|
2087
|
+
"delete existing dist folder before writing new compiled files"
|
|
2088
|
+
]
|
|
2089
|
+
],
|
|
2090
|
+
"description": "compile components in the development workspace",
|
|
2091
|
+
"extendedDescription": "",
|
|
2092
|
+
"group": "development",
|
|
2093
|
+
"private": false
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"name": "run <app>",
|
|
2097
|
+
"alias": "c",
|
|
2098
|
+
"options": [
|
|
2099
|
+
[
|
|
2100
|
+
"d",
|
|
2101
|
+
"dev",
|
|
2102
|
+
"start the application in dev mode."
|
|
2103
|
+
],
|
|
2104
|
+
[
|
|
2105
|
+
"v",
|
|
2106
|
+
"verbose",
|
|
2107
|
+
"showing verbose output for inspection and prints stack trace"
|
|
2108
|
+
],
|
|
2109
|
+
[
|
|
2110
|
+
"",
|
|
2111
|
+
"skip-watch",
|
|
2112
|
+
"avoid running the watch process that compiles components in the background"
|
|
2113
|
+
]
|
|
2114
|
+
],
|
|
2115
|
+
"description": "run an application",
|
|
2116
|
+
"extendedDescription": "",
|
|
2117
|
+
"group": "apps",
|
|
2118
|
+
"private": false
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
"name": "app-list",
|
|
2122
|
+
"alias": "",
|
|
2123
|
+
"options": [
|
|
2124
|
+
[
|
|
2125
|
+
"j",
|
|
2126
|
+
"json",
|
|
2127
|
+
"return the component data in json format"
|
|
2128
|
+
]
|
|
2129
|
+
],
|
|
2130
|
+
"description": "DEPRECATED. use \"bit app list\"",
|
|
2131
|
+
"extendedDescription": "",
|
|
2132
|
+
"group": "apps",
|
|
2133
|
+
"private": true
|
|
2134
|
+
},
|
|
2135
|
+
{
|
|
2136
|
+
"name": "app <sub-command>",
|
|
2137
|
+
"alias": "",
|
|
2138
|
+
"options": [],
|
|
2139
|
+
"description": "manage applications",
|
|
2140
|
+
"extendedDescription": "",
|
|
2141
|
+
"group": "apps",
|
|
2142
|
+
"private": false,
|
|
2143
|
+
"commands": [
|
|
2144
|
+
{
|
|
2145
|
+
"name": "list",
|
|
2146
|
+
"alias": "",
|
|
2147
|
+
"options": [
|
|
2148
|
+
[
|
|
2149
|
+
"j",
|
|
2150
|
+
"json",
|
|
2151
|
+
"return the component data in json format"
|
|
2152
|
+
]
|
|
2153
|
+
],
|
|
2154
|
+
"description": "list all registered applications",
|
|
2155
|
+
"extendedDescription": "",
|
|
2156
|
+
"group": "apps",
|
|
2157
|
+
"private": false
|
|
2158
|
+
}
|
|
2159
|
+
]
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
"name": "test [pattern]",
|
|
2163
|
+
"alias": "at",
|
|
2164
|
+
"options": [
|
|
2165
|
+
[
|
|
2166
|
+
"w",
|
|
2167
|
+
"watch",
|
|
2168
|
+
"start the tester in watch mode."
|
|
2169
|
+
],
|
|
2170
|
+
[
|
|
2171
|
+
"d",
|
|
2172
|
+
"debug",
|
|
2173
|
+
"start the tester in debug mode."
|
|
2174
|
+
],
|
|
2175
|
+
[
|
|
2176
|
+
"a",
|
|
2177
|
+
"all",
|
|
2178
|
+
"test all components, not only new and modified"
|
|
2179
|
+
],
|
|
2180
|
+
[
|
|
2181
|
+
"",
|
|
2182
|
+
"junit <filepath>",
|
|
2183
|
+
"write tests results as JUnit XML format into the specified file path"
|
|
2184
|
+
],
|
|
2185
|
+
[
|
|
2186
|
+
"",
|
|
2187
|
+
"coverage",
|
|
2188
|
+
"show code coverage data"
|
|
2189
|
+
],
|
|
2190
|
+
[
|
|
2191
|
+
"e",
|
|
2192
|
+
"env <id>",
|
|
2193
|
+
"test only the given env"
|
|
2194
|
+
],
|
|
2195
|
+
[
|
|
2196
|
+
"s",
|
|
2197
|
+
"scope <scope>",
|
|
2198
|
+
"name of the scope to test"
|
|
2199
|
+
]
|
|
2200
|
+
],
|
|
2201
|
+
"description": "test set of components in your workspace",
|
|
2202
|
+
"extendedDescription": "",
|
|
2203
|
+
"group": "development",
|
|
2204
|
+
"private": false
|
|
2205
|
+
},
|
|
2206
|
+
{
|
|
2207
|
+
"name": "schema <pattern>",
|
|
2208
|
+
"alias": "",
|
|
2209
|
+
"options": [
|
|
2210
|
+
[
|
|
2211
|
+
"j",
|
|
2212
|
+
"json",
|
|
2213
|
+
"return the component data in json format"
|
|
2214
|
+
]
|
|
2215
|
+
],
|
|
2216
|
+
"description": "shows the API schema of a certain component.",
|
|
2217
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
2218
|
+
"group": "development",
|
|
2219
|
+
"private": false
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
"name": "check-types [pattern]",
|
|
2223
|
+
"alias": "",
|
|
2224
|
+
"options": [
|
|
2225
|
+
[
|
|
2226
|
+
"a",
|
|
2227
|
+
"all",
|
|
2228
|
+
"check-types for all components, not only modified and new"
|
|
2229
|
+
],
|
|
2230
|
+
[
|
|
2231
|
+
"",
|
|
2232
|
+
"strict",
|
|
2233
|
+
"in case issues found, exit with code 1"
|
|
2234
|
+
]
|
|
2235
|
+
],
|
|
2236
|
+
"description": "check typescript types",
|
|
2237
|
+
"extendedDescription": "",
|
|
2238
|
+
"group": "development",
|
|
2239
|
+
"private": false
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "aspect <sub-command>",
|
|
2243
|
+
"alias": "",
|
|
2244
|
+
"options": [],
|
|
2245
|
+
"description": "EXPERIMENTAL. manage aspects",
|
|
2246
|
+
"extendedDescription": "",
|
|
2247
|
+
"group": "development",
|
|
2248
|
+
"private": false,
|
|
2249
|
+
"commands": [
|
|
2250
|
+
{
|
|
2251
|
+
"name": "list [pattern]",
|
|
2252
|
+
"alias": "",
|
|
2253
|
+
"options": [
|
|
2254
|
+
[
|
|
2255
|
+
"d",
|
|
2256
|
+
"debug",
|
|
2257
|
+
"show the origins were the aspects were taken from"
|
|
2258
|
+
]
|
|
2259
|
+
],
|
|
2260
|
+
"description": "list all aspects configured on component(s)",
|
|
2261
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect list \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
2262
|
+
"group": "development",
|
|
2263
|
+
"private": false
|
|
2264
|
+
},
|
|
2265
|
+
{
|
|
2266
|
+
"name": "get <component-id>",
|
|
2267
|
+
"alias": "",
|
|
2268
|
+
"options": [
|
|
2269
|
+
[
|
|
2270
|
+
"d",
|
|
2271
|
+
"debug",
|
|
2272
|
+
"show the origins were the aspects were taken from"
|
|
2273
|
+
],
|
|
2274
|
+
[
|
|
2275
|
+
"j",
|
|
2276
|
+
"json",
|
|
2277
|
+
"format as json"
|
|
2278
|
+
]
|
|
2279
|
+
],
|
|
2280
|
+
"description": "show aspects' data and configuration of the given component",
|
|
2281
|
+
"extendedDescription": "",
|
|
2282
|
+
"group": "development",
|
|
2283
|
+
"private": false
|
|
2284
|
+
},
|
|
2285
|
+
{
|
|
2286
|
+
"name": "set <pattern> <aspect-id> [config]",
|
|
2287
|
+
"alias": "",
|
|
2288
|
+
"options": [],
|
|
2289
|
+
"description": "set an aspect to component(s) with optional config.",
|
|
2290
|
+
"extendedDescription": "enter the config as stringified JSON (e.g. '{\"foo\":\"bar\"}' ).\nif no config entered, the aspect will be set with empty config ({}).\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect set \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
2291
|
+
"group": "development",
|
|
2292
|
+
"private": false
|
|
2293
|
+
},
|
|
2294
|
+
{
|
|
2295
|
+
"name": "unset <pattern> <aspect-id>",
|
|
2296
|
+
"alias": "",
|
|
2297
|
+
"options": [],
|
|
2298
|
+
"description": "unset an aspect from component(s).",
|
|
2299
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
2300
|
+
"group": "development",
|
|
2301
|
+
"private": false
|
|
2302
|
+
},
|
|
2303
|
+
{
|
|
2304
|
+
"name": "update <aspect-id> [pattern]",
|
|
2305
|
+
"alias": "",
|
|
2306
|
+
"options": [],
|
|
2307
|
+
"description": "update a version of an aspect",
|
|
2308
|
+
"extendedDescription": "default to all components using the aspect, unless \"pattern\" is provided.\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n\nexamples:\n\"bit aspect update scope.org/aspect '**/ui/**'\" - update \"ui\" components that use scope.org/aspect to the latest version\n\"bit aspect update scope.org/aspect@2.0.0\" - updates all components using scope.org/aspect to version 2.0.0.",
|
|
2309
|
+
"group": "development",
|
|
2310
|
+
"private": false
|
|
2311
|
+
}
|
|
2312
|
+
]
|
|
2313
|
+
},
|
|
2314
|
+
{
|
|
2315
|
+
"name": "clear-cache",
|
|
2316
|
+
"alias": "cc",
|
|
2317
|
+
"options": [
|
|
2318
|
+
[
|
|
2319
|
+
"r",
|
|
2320
|
+
"remote <remote-name>",
|
|
2321
|
+
"clear memory cache from a remote scope"
|
|
2322
|
+
]
|
|
2323
|
+
],
|
|
2324
|
+
"description": "clears Bit's cache from current working machine",
|
|
2325
|
+
"extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash\nhttps://bit.dev/docs/workspace/clearing-cache",
|
|
2326
|
+
"group": "general",
|
|
2327
|
+
"private": false,
|
|
2328
|
+
"skipWorkspace": true
|
|
2329
|
+
},
|
|
2330
|
+
{
|
|
2331
|
+
"name": "log <id>",
|
|
2332
|
+
"alias": "",
|
|
2333
|
+
"options": [
|
|
2334
|
+
[
|
|
2335
|
+
"r",
|
|
2336
|
+
"remote",
|
|
2337
|
+
"show log of a remote component"
|
|
2338
|
+
],
|
|
2339
|
+
[
|
|
2340
|
+
"",
|
|
2341
|
+
"parents",
|
|
2342
|
+
"EXPERIMENTAL. show parents and lanes data"
|
|
2343
|
+
]
|
|
2344
|
+
],
|
|
2345
|
+
"description": "show components(s) version history",
|
|
2346
|
+
"extendedDescription": "https://bit.dev/docs/reference/cli-reference#log",
|
|
2347
|
+
"group": "info",
|
|
2348
|
+
"private": false,
|
|
2349
|
+
"remoteOp": true,
|
|
2350
|
+
"skipWorkspace": true
|
|
2351
|
+
},
|
|
2352
|
+
{
|
|
2353
|
+
"name": "deprecate <id>",
|
|
2354
|
+
"alias": "d",
|
|
2355
|
+
"options": [
|
|
2356
|
+
[
|
|
2357
|
+
"",
|
|
2358
|
+
"new-id <string>",
|
|
2359
|
+
"if replaced by another component, enter the new component id"
|
|
2360
|
+
]
|
|
2361
|
+
],
|
|
2362
|
+
"description": "deprecate a component",
|
|
2363
|
+
"extendedDescription": "",
|
|
2364
|
+
"group": "collaborate",
|
|
2365
|
+
"private": false,
|
|
2366
|
+
"remoteOp": true,
|
|
2367
|
+
"skipWorkspace": true
|
|
2368
|
+
},
|
|
2369
|
+
{
|
|
2370
|
+
"name": "undeprecate <id>",
|
|
2371
|
+
"alias": "",
|
|
2372
|
+
"options": [],
|
|
2373
|
+
"description": "undeprecate a deprecated component (local/remote)",
|
|
2374
|
+
"extendedDescription": "",
|
|
2375
|
+
"group": "collaborate",
|
|
2376
|
+
"private": false,
|
|
2377
|
+
"remoteOp": true,
|
|
2378
|
+
"skipWorkspace": true
|
|
2379
|
+
},
|
|
2380
|
+
{
|
|
2381
|
+
"name": "rename <source-name> <target-name>",
|
|
2382
|
+
"alias": "",
|
|
2383
|
+
"options": [
|
|
2384
|
+
[
|
|
2385
|
+
"s",
|
|
2386
|
+
"scope <string>",
|
|
2387
|
+
"default scope for the newly created component"
|
|
2388
|
+
],
|
|
2389
|
+
[
|
|
2390
|
+
"p",
|
|
2391
|
+
"path <string>",
|
|
2392
|
+
"relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
|
|
2393
|
+
],
|
|
2394
|
+
[
|
|
2395
|
+
"r",
|
|
2396
|
+
"refactor",
|
|
2397
|
+
"change the source code of all components using this component with the new package-name"
|
|
2398
|
+
]
|
|
2399
|
+
],
|
|
2400
|
+
"description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the source-component",
|
|
2401
|
+
"extendedDescription": "the `<target-name>` should include the component-name only, without the scope-name.\nto assign a default-scope to this component, please use \"--scope\" flag",
|
|
2402
|
+
"group": "collaborate",
|
|
2403
|
+
"private": false,
|
|
2404
|
+
"remoteOp": true,
|
|
2405
|
+
"skipWorkspace": true
|
|
2406
|
+
},
|
|
2407
|
+
{
|
|
2408
|
+
"name": "fork <source-id> [target-name]",
|
|
2409
|
+
"alias": "",
|
|
2410
|
+
"options": [
|
|
2411
|
+
[
|
|
2412
|
+
"s",
|
|
2413
|
+
"scope <string>",
|
|
2414
|
+
"default scope for the newly created component"
|
|
2415
|
+
],
|
|
2416
|
+
[
|
|
2417
|
+
"p",
|
|
2418
|
+
"path <string>",
|
|
2419
|
+
"relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
|
|
2420
|
+
],
|
|
2421
|
+
[
|
|
2422
|
+
"r",
|
|
2423
|
+
"refactor",
|
|
2424
|
+
"change the source code of all components using the original component with the new package-name"
|
|
2425
|
+
]
|
|
2426
|
+
],
|
|
2427
|
+
"description": "EXPERIMENTAL. create a new component out of an existing one",
|
|
2428
|
+
"extendedDescription": "note that [target-name] is the name only without the scope.\nto set the default-scope, please use --scope flag",
|
|
2429
|
+
"group": "collaborate",
|
|
2430
|
+
"private": false,
|
|
2431
|
+
"remoteOp": true,
|
|
2432
|
+
"skipWorkspace": true
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
"name": "lane [name]",
|
|
2436
|
+
"alias": "",
|
|
2437
|
+
"options": [
|
|
2438
|
+
[
|
|
2439
|
+
"d",
|
|
2440
|
+
"details",
|
|
2441
|
+
"show more details on the state of each component in each lane"
|
|
2442
|
+
],
|
|
2443
|
+
[
|
|
2444
|
+
"j",
|
|
2445
|
+
"json",
|
|
2446
|
+
"show lanes details in json format"
|
|
2447
|
+
],
|
|
2448
|
+
[
|
|
2449
|
+
"r",
|
|
2450
|
+
"remote <string>",
|
|
2451
|
+
"show remote lanes"
|
|
2452
|
+
],
|
|
2453
|
+
[
|
|
2454
|
+
"",
|
|
2455
|
+
"merged",
|
|
2456
|
+
"show merged lanes"
|
|
2457
|
+
],
|
|
2458
|
+
[
|
|
2459
|
+
"",
|
|
2460
|
+
"not-merged",
|
|
2461
|
+
"show not merged lanes"
|
|
2462
|
+
]
|
|
2463
|
+
],
|
|
2464
|
+
"description": "show lanes details\nhttps://bit.dev/docs/components/lanes",
|
|
2465
|
+
"extendedDescription": "",
|
|
2466
|
+
"group": "ungrouped",
|
|
2467
|
+
"private": true,
|
|
2468
|
+
"remoteOp": true,
|
|
2469
|
+
"skipWorkspace": true,
|
|
2470
|
+
"commands": [
|
|
2471
|
+
{
|
|
2472
|
+
"name": "list",
|
|
2473
|
+
"alias": "",
|
|
2474
|
+
"options": [
|
|
2475
|
+
[
|
|
2476
|
+
"d",
|
|
2477
|
+
"details",
|
|
2478
|
+
"show more details on the state of each component in each lane"
|
|
2479
|
+
],
|
|
2480
|
+
[
|
|
2481
|
+
"j",
|
|
2482
|
+
"json",
|
|
2483
|
+
"show lanes details in json format"
|
|
2484
|
+
],
|
|
2485
|
+
[
|
|
2486
|
+
"r",
|
|
2487
|
+
"remote <string>",
|
|
2488
|
+
"show remote lanes"
|
|
2489
|
+
],
|
|
2490
|
+
[
|
|
2491
|
+
"",
|
|
2492
|
+
"merged",
|
|
2493
|
+
"show merged lanes"
|
|
2494
|
+
],
|
|
2495
|
+
[
|
|
2496
|
+
"",
|
|
2497
|
+
"not-merged",
|
|
2498
|
+
"show not merged lanes"
|
|
2499
|
+
]
|
|
2500
|
+
],
|
|
2501
|
+
"description": "list lanes",
|
|
2502
|
+
"extendedDescription": "",
|
|
2503
|
+
"group": "ungrouped",
|
|
2504
|
+
"private": true,
|
|
2505
|
+
"remoteOp": true,
|
|
2506
|
+
"skipWorkspace": true
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"name": "switch <lane>",
|
|
2510
|
+
"alias": "",
|
|
2511
|
+
"options": [
|
|
2512
|
+
[
|
|
2513
|
+
"n",
|
|
2514
|
+
"alias <string>",
|
|
2515
|
+
"relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
|
|
2516
|
+
],
|
|
2517
|
+
[
|
|
2518
|
+
"m",
|
|
2519
|
+
"merge [strategy]",
|
|
2520
|
+
"merge local changes with the checked out version. strategy should be \"theirs\", \"ours\" or \"manual\""
|
|
2521
|
+
],
|
|
2522
|
+
[
|
|
2523
|
+
"a",
|
|
2524
|
+
"get-all",
|
|
2525
|
+
"checkout all components in a lane include ones that do not exist in the workspace"
|
|
2526
|
+
],
|
|
2527
|
+
[
|
|
2528
|
+
"",
|
|
2529
|
+
"skip-dependency-installation",
|
|
2530
|
+
"do not install packages of the imported components"
|
|
2531
|
+
],
|
|
2532
|
+
[
|
|
2533
|
+
"j",
|
|
2534
|
+
"json",
|
|
2535
|
+
"return the output as JSON"
|
|
2536
|
+
]
|
|
2537
|
+
],
|
|
2538
|
+
"description": "switch to the specified lane",
|
|
2539
|
+
"extendedDescription": "",
|
|
2540
|
+
"group": "ungrouped",
|
|
2541
|
+
"private": true
|
|
2542
|
+
},
|
|
2543
|
+
{
|
|
2544
|
+
"name": "show <name>",
|
|
2545
|
+
"alias": "",
|
|
2546
|
+
"options": [
|
|
2547
|
+
[
|
|
2548
|
+
"j",
|
|
2549
|
+
"json",
|
|
2550
|
+
"show the lane details in json format"
|
|
2551
|
+
],
|
|
2552
|
+
[
|
|
2553
|
+
"r",
|
|
2554
|
+
"remote <string>",
|
|
2555
|
+
"show remote lanes"
|
|
2556
|
+
]
|
|
2557
|
+
],
|
|
2558
|
+
"description": "show lane details",
|
|
2559
|
+
"extendedDescription": "",
|
|
2560
|
+
"group": "ungrouped",
|
|
2561
|
+
"private": true,
|
|
2562
|
+
"remoteOp": true,
|
|
2563
|
+
"skipWorkspace": true
|
|
2564
|
+
},
|
|
2565
|
+
{
|
|
2566
|
+
"name": "create <name>",
|
|
2567
|
+
"alias": "",
|
|
2568
|
+
"options": [
|
|
2569
|
+
[
|
|
2570
|
+
"",
|
|
2571
|
+
"remote-scope <string>",
|
|
2572
|
+
"remote scope where this lane will be exported to, default to the defaultScope (can be changed later with \"bit lane change-scope\")"
|
|
2573
|
+
],
|
|
2574
|
+
[
|
|
2575
|
+
"",
|
|
2576
|
+
"alias <string>",
|
|
2577
|
+
"a local alias to refer to this lane, default to the <name> (can be added later with \"bit lane alias\")"
|
|
2578
|
+
]
|
|
2579
|
+
],
|
|
2580
|
+
"description": "create and switch to a new lane",
|
|
2581
|
+
"extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
|
|
2582
|
+
"group": "ungrouped",
|
|
2583
|
+
"private": true
|
|
2584
|
+
},
|
|
2585
|
+
{
|
|
2586
|
+
"name": "merge <lane>",
|
|
2587
|
+
"alias": "",
|
|
2588
|
+
"options": [
|
|
2589
|
+
[
|
|
2590
|
+
"",
|
|
2591
|
+
"remote <name>",
|
|
2592
|
+
"remote scope name"
|
|
2593
|
+
],
|
|
2594
|
+
[
|
|
2595
|
+
"",
|
|
2596
|
+
"ours",
|
|
2597
|
+
"in case of a conflict, override the used version with the current modification"
|
|
2598
|
+
],
|
|
2599
|
+
[
|
|
2600
|
+
"",
|
|
2601
|
+
"theirs",
|
|
2602
|
+
"in case of a conflict, override the current modification with the specified version"
|
|
2603
|
+
],
|
|
2604
|
+
[
|
|
2605
|
+
"",
|
|
2606
|
+
"manual",
|
|
2607
|
+
"in case of a conflict, leave the files with a conflict state to resolve them manually later"
|
|
2608
|
+
],
|
|
2609
|
+
[
|
|
2610
|
+
"",
|
|
2611
|
+
"existing",
|
|
2612
|
+
"checkout only components in a lane that exist in the workspace"
|
|
2613
|
+
],
|
|
2614
|
+
[
|
|
2615
|
+
"",
|
|
2616
|
+
"no-snap",
|
|
2617
|
+
"do not auto snap in case the merge completed without conflicts"
|
|
2618
|
+
],
|
|
2619
|
+
[
|
|
2620
|
+
"",
|
|
2621
|
+
"build",
|
|
2622
|
+
"in case of snap during the merge, run the build-pipeline (similar to bit snap --build)"
|
|
2623
|
+
],
|
|
2624
|
+
[
|
|
2625
|
+
"m",
|
|
2626
|
+
"message <message>",
|
|
2627
|
+
"override the default message for the auto snap"
|
|
2628
|
+
],
|
|
2629
|
+
[
|
|
2630
|
+
"",
|
|
2631
|
+
"keep-readme",
|
|
2632
|
+
"skip deleting the lane readme component after merging"
|
|
2633
|
+
]
|
|
2634
|
+
],
|
|
2635
|
+
"description": "merge a local or a remote lane",
|
|
2636
|
+
"extendedDescription": "",
|
|
2637
|
+
"group": "ungrouped",
|
|
2638
|
+
"private": true,
|
|
2639
|
+
"remoteOp": true
|
|
2640
|
+
},
|
|
2641
|
+
{
|
|
2642
|
+
"name": "remove <lane...>",
|
|
2643
|
+
"alias": "",
|
|
2644
|
+
"options": [
|
|
2645
|
+
[
|
|
2646
|
+
"r",
|
|
2647
|
+
"remote",
|
|
2648
|
+
"remove a remote lane (in the lane arg, use remote/lane-id syntax)"
|
|
2649
|
+
],
|
|
2650
|
+
[
|
|
2651
|
+
"f",
|
|
2652
|
+
"force",
|
|
2653
|
+
"removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
|
|
2654
|
+
],
|
|
2655
|
+
[
|
|
2656
|
+
"s",
|
|
2657
|
+
"silent",
|
|
2658
|
+
"skip confirmation"
|
|
2659
|
+
]
|
|
2660
|
+
],
|
|
2661
|
+
"description": "remove lanes",
|
|
2662
|
+
"extendedDescription": "",
|
|
2663
|
+
"group": "ungrouped",
|
|
2664
|
+
"private": true
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"name": "change-scope <lane-name> <remote-scope>",
|
|
2668
|
+
"alias": "",
|
|
2669
|
+
"options": [],
|
|
2670
|
+
"description": "change the remote scope of a lane",
|
|
2671
|
+
"extendedDescription": "",
|
|
2672
|
+
"group": "ungrouped",
|
|
2673
|
+
"private": true
|
|
2674
|
+
},
|
|
2675
|
+
{
|
|
2676
|
+
"name": "alias <lane-name> <alias>",
|
|
2677
|
+
"alias": "",
|
|
2678
|
+
"options": [],
|
|
2679
|
+
"description": "add an alias to a lane",
|
|
2680
|
+
"extendedDescription": "an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.\nit is useful when having multiple lanes with the same name, but with different remote scopes.",
|
|
2681
|
+
"group": "ungrouped",
|
|
2682
|
+
"private": true
|
|
2683
|
+
},
|
|
2684
|
+
{
|
|
2685
|
+
"name": "rename <current-name> <new-name>",
|
|
2686
|
+
"alias": "",
|
|
2687
|
+
"options": [],
|
|
2688
|
+
"description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
|
|
2689
|
+
"extendedDescription": "",
|
|
2690
|
+
"group": "ungrouped",
|
|
2691
|
+
"private": true
|
|
2692
|
+
},
|
|
2693
|
+
{
|
|
2694
|
+
"name": "diff [values...]",
|
|
2695
|
+
"alias": "",
|
|
2696
|
+
"options": [],
|
|
2697
|
+
"description": "show diff between lanes",
|
|
2698
|
+
"extendedDescription": "bit lane diff => diff between the current lane and default lane. (only inside workspace).\nbit lane diff to => diff between the current lane (or default-lane when in scope) and \"to\" lane.\nbit lane diff from to => diff between \"from\" lane and \"to\" lane.",
|
|
2699
|
+
"group": "ungrouped",
|
|
2700
|
+
"private": true,
|
|
2701
|
+
"remoteOp": true,
|
|
2702
|
+
"skipWorkspace": true
|
|
2703
|
+
},
|
|
2704
|
+
{
|
|
2705
|
+
"name": "add-readme <componentId> [laneName]",
|
|
2706
|
+
"alias": "",
|
|
2707
|
+
"options": [],
|
|
2708
|
+
"description": "EXPERIMENTAL. add lane readme component",
|
|
2709
|
+
"extendedDescription": "",
|
|
2710
|
+
"group": "ungrouped",
|
|
2711
|
+
"private": true,
|
|
2712
|
+
"skipWorkspace": false
|
|
2713
|
+
},
|
|
2714
|
+
{
|
|
2715
|
+
"name": "remove-readme [laneName]",
|
|
2716
|
+
"alias": "",
|
|
2717
|
+
"options": [],
|
|
2718
|
+
"description": "EXPERIMENTAL. remove lane readme component",
|
|
2719
|
+
"extendedDescription": "",
|
|
2720
|
+
"group": "ungrouped",
|
|
2721
|
+
"private": true,
|
|
2722
|
+
"skipWorkspace": false
|
|
2723
|
+
},
|
|
2724
|
+
{
|
|
2725
|
+
"name": "import <lane>",
|
|
2726
|
+
"alias": "",
|
|
2727
|
+
"options": [
|
|
2728
|
+
[
|
|
2729
|
+
"",
|
|
2730
|
+
"skip-dependency-installation",
|
|
2731
|
+
"do not install packages of the imported components"
|
|
2732
|
+
]
|
|
2733
|
+
],
|
|
2734
|
+
"description": "import a remote lane to your workspace",
|
|
2735
|
+
"extendedDescription": "",
|
|
2736
|
+
"group": "ungrouped",
|
|
2737
|
+
"private": true
|
|
2738
|
+
}
|
|
2739
|
+
]
|
|
2740
|
+
},
|
|
2741
|
+
{
|
|
2742
|
+
"name": "switch <lane>",
|
|
2743
|
+
"alias": "",
|
|
2744
|
+
"options": [
|
|
2745
|
+
[
|
|
2746
|
+
"n",
|
|
2747
|
+
"alias <string>",
|
|
2748
|
+
"relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
|
|
2749
|
+
],
|
|
2750
|
+
[
|
|
2751
|
+
"m",
|
|
2752
|
+
"merge [strategy]",
|
|
2753
|
+
"merge local changes with the checked out version. strategy should be \"theirs\", \"ours\" or \"manual\""
|
|
2754
|
+
],
|
|
2755
|
+
[
|
|
2756
|
+
"a",
|
|
2757
|
+
"get-all",
|
|
2758
|
+
"checkout all components in a lane include ones that do not exist in the workspace"
|
|
2759
|
+
],
|
|
2760
|
+
[
|
|
2761
|
+
"",
|
|
2762
|
+
"skip-dependency-installation",
|
|
2763
|
+
"do not install packages of the imported components"
|
|
2764
|
+
],
|
|
2765
|
+
[
|
|
2766
|
+
"j",
|
|
2767
|
+
"json",
|
|
2768
|
+
"return the output as JSON"
|
|
2769
|
+
]
|
|
2770
|
+
],
|
|
2771
|
+
"description": "switch to the specified lane",
|
|
2772
|
+
"extendedDescription": "",
|
|
2773
|
+
"group": "ungrouped",
|
|
2774
|
+
"private": true
|
|
2775
|
+
},
|
|
2776
|
+
{
|
|
2777
|
+
"name": "eject <pattern>",
|
|
2778
|
+
"alias": "E",
|
|
2779
|
+
"options": [
|
|
2780
|
+
[
|
|
2781
|
+
"f",
|
|
2782
|
+
"force",
|
|
2783
|
+
"ignore local version. remove the components even when they are staged or modified"
|
|
2784
|
+
],
|
|
2785
|
+
[
|
|
2786
|
+
"j",
|
|
2787
|
+
"json",
|
|
2788
|
+
"print the results in JSON format"
|
|
2789
|
+
],
|
|
2790
|
+
[
|
|
2791
|
+
"",
|
|
2792
|
+
"keep-files",
|
|
2793
|
+
"keep the component files in the workspace intact"
|
|
2794
|
+
]
|
|
2795
|
+
],
|
|
2796
|
+
"description": "replaces the components from the local scope with the corresponding packages",
|
|
2797
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
2798
|
+
"group": "development",
|
|
2799
|
+
"private": false
|
|
2800
|
+
},
|
|
2801
|
+
{
|
|
2802
|
+
"name": "resume-export <export-id> <remotes...>",
|
|
2803
|
+
"alias": "",
|
|
2804
|
+
"options": [],
|
|
2805
|
+
"description": "EXPERIMENTAL. resume failed export",
|
|
2806
|
+
"extendedDescription": "resume failed export to persist the pending objects on the given remotes.\nthe export-id is the id the client got in the error message during the failure.\nalternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id",
|
|
2807
|
+
"group": "collaborate",
|
|
2808
|
+
"private": true,
|
|
2809
|
+
"remoteOp": true
|
|
2810
|
+
},
|
|
2811
|
+
{
|
|
2812
|
+
"name": "export [remote] [id...]",
|
|
2813
|
+
"alias": "e",
|
|
2814
|
+
"options": [
|
|
2815
|
+
[
|
|
2816
|
+
"e",
|
|
2817
|
+
"eject",
|
|
2818
|
+
"replaces the exported components from the local scope with the corresponding packages"
|
|
2819
|
+
],
|
|
2820
|
+
[
|
|
2821
|
+
"a",
|
|
2822
|
+
"all",
|
|
2823
|
+
"export all components include non-staged"
|
|
2824
|
+
],
|
|
2825
|
+
[
|
|
2826
|
+
"d",
|
|
2827
|
+
"include-dependencies",
|
|
2828
|
+
"LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
|
|
2829
|
+
],
|
|
2830
|
+
[
|
|
2831
|
+
"s",
|
|
2832
|
+
"set-current-scope",
|
|
2833
|
+
"LEGACY ONLY. ensure the component's remote scope is set according to the target location"
|
|
2834
|
+
],
|
|
2835
|
+
[
|
|
2836
|
+
"r",
|
|
2837
|
+
"rewire",
|
|
2838
|
+
"LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
|
|
2839
|
+
],
|
|
2840
|
+
[
|
|
2841
|
+
"f",
|
|
2842
|
+
"force",
|
|
2843
|
+
"force changing a component remote without asking for a confirmation"
|
|
2844
|
+
],
|
|
2845
|
+
[
|
|
2846
|
+
"",
|
|
2847
|
+
"all-versions",
|
|
2848
|
+
"export not only staged versions but all of them"
|
|
2849
|
+
],
|
|
2850
|
+
[
|
|
2851
|
+
"",
|
|
2852
|
+
"origin-directly",
|
|
2853
|
+
"HARMONY ONLY. avoid export to the central hub, instead, export directly to the original scopes. not recommended!"
|
|
2854
|
+
],
|
|
2855
|
+
[
|
|
2856
|
+
"",
|
|
2857
|
+
"resume <string>",
|
|
2858
|
+
"in case the previous export failed and suggested to resume with an export-id, enter the id"
|
|
2859
|
+
],
|
|
2860
|
+
[
|
|
2861
|
+
"",
|
|
2862
|
+
"ignore-missing-artifacts",
|
|
2863
|
+
"EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote"
|
|
2864
|
+
],
|
|
2865
|
+
[
|
|
2866
|
+
"j",
|
|
2867
|
+
"json",
|
|
2868
|
+
"show output in json format"
|
|
2869
|
+
]
|
|
2870
|
+
],
|
|
2871
|
+
"description": "Export components to a remote scope",
|
|
2872
|
+
"extendedDescription": "bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well\n`bit export [id...]` => export the given ids to their current scope\n\nhttps://bit.dev/docs/components/exporting-components\nyou can use a pattern for multiple ids, such as bit export remote-scope \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
2873
|
+
"group": "collaborate",
|
|
2874
|
+
"private": false,
|
|
2875
|
+
"remoteOp": true
|
|
2876
|
+
},
|
|
2877
|
+
{
|
|
2878
|
+
"name": "update-dependencies <data>",
|
|
2879
|
+
"alias": "",
|
|
2880
|
+
"options": [
|
|
2881
|
+
[
|
|
2882
|
+
"",
|
|
2883
|
+
"tag",
|
|
2884
|
+
"tag once the build is completed (by default it snaps)"
|
|
2885
|
+
],
|
|
2886
|
+
[
|
|
2887
|
+
"",
|
|
2888
|
+
"simulation",
|
|
2889
|
+
"simulation purpose. should never be pushed (otherwise, flattened-deps are invalid)"
|
|
2890
|
+
],
|
|
2891
|
+
[
|
|
2892
|
+
"",
|
|
2893
|
+
"push",
|
|
2894
|
+
"export the updated objects to the original scopes once tagged/snapped"
|
|
2895
|
+
],
|
|
2896
|
+
[
|
|
2897
|
+
"",
|
|
2898
|
+
"message <string>",
|
|
2899
|
+
"message to be saved as part of the version log"
|
|
2900
|
+
],
|
|
2901
|
+
[
|
|
2902
|
+
"",
|
|
2903
|
+
"username <string>",
|
|
2904
|
+
"username to be saved as part of the version log"
|
|
2905
|
+
],
|
|
2906
|
+
[
|
|
2907
|
+
"",
|
|
2908
|
+
"email <string>",
|
|
2909
|
+
"email to be saved as part of the version log"
|
|
2910
|
+
],
|
|
2911
|
+
[
|
|
2912
|
+
"",
|
|
2913
|
+
"skip-new-scope-validation",
|
|
2914
|
+
"avoid throwing an error when running on a non-new scope"
|
|
2915
|
+
]
|
|
2916
|
+
],
|
|
2917
|
+
"description": "update dependencies for components and tag/snap the results",
|
|
2918
|
+
"extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the update.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n versionToTag?: string; // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
|
|
2919
|
+
"group": "development",
|
|
2920
|
+
"private": true
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
"name": "sign [component...]",
|
|
2924
|
+
"alias": "",
|
|
2925
|
+
"options": [
|
|
2926
|
+
[
|
|
2927
|
+
"",
|
|
2928
|
+
"multiple",
|
|
2929
|
+
"sign components from multiple scopes"
|
|
2930
|
+
],
|
|
2931
|
+
[
|
|
2932
|
+
"",
|
|
2933
|
+
"always-succeed",
|
|
2934
|
+
"exit with code 0 even though the build failed"
|
|
2935
|
+
],
|
|
2936
|
+
[
|
|
2937
|
+
"",
|
|
2938
|
+
"push",
|
|
2939
|
+
"export the updated objects to the original scopes once done"
|
|
2940
|
+
],
|
|
2941
|
+
[
|
|
2942
|
+
"",
|
|
2943
|
+
"lane <lane-id>",
|
|
2944
|
+
"helps to fetch the components from the lane scope (relevant for --multiple)"
|
|
2945
|
+
]
|
|
2946
|
+
],
|
|
2947
|
+
"description": "complete the build process for components",
|
|
2948
|
+
"extendedDescription": "without --multiple, this will be running on the original scope.\nwith --multiple, a new bare-scope needs to be created and it will import the components to this scope first",
|
|
2949
|
+
"group": "development",
|
|
2950
|
+
"private": true
|
|
2951
|
+
},
|
|
2952
|
+
{
|
|
2953
|
+
"name": "format [component...]",
|
|
2954
|
+
"alias": "",
|
|
2955
|
+
"options": [
|
|
2956
|
+
[
|
|
2957
|
+
"c",
|
|
2958
|
+
"changed",
|
|
2959
|
+
"format only new and modified components"
|
|
2960
|
+
],
|
|
2961
|
+
[
|
|
2962
|
+
"",
|
|
2963
|
+
"check",
|
|
2964
|
+
"will output a human-friendly message and a list of unformatted files, if any"
|
|
2965
|
+
],
|
|
2966
|
+
[
|
|
2967
|
+
"j",
|
|
2968
|
+
"json",
|
|
2969
|
+
"return the format results in json format"
|
|
2970
|
+
]
|
|
2971
|
+
],
|
|
2972
|
+
"description": "format components in the development workspace",
|
|
2973
|
+
"extendedDescription": "",
|
|
2974
|
+
"group": "development",
|
|
2975
|
+
"private": false
|
|
2976
|
+
},
|
|
2977
|
+
{
|
|
2978
|
+
"name": "lint [component...]",
|
|
2979
|
+
"alias": "",
|
|
2980
|
+
"options": [
|
|
2981
|
+
[
|
|
2982
|
+
"c",
|
|
2983
|
+
"changed",
|
|
2984
|
+
"lint only new and modified components"
|
|
2985
|
+
],
|
|
2986
|
+
[
|
|
2987
|
+
"f",
|
|
2988
|
+
"fix",
|
|
2989
|
+
"automatically fix problems"
|
|
2990
|
+
],
|
|
2991
|
+
[
|
|
2992
|
+
"",
|
|
2993
|
+
"fix-type <fixType>",
|
|
2994
|
+
"specify the types of fixes to apply (problem, suggestion, layout)"
|
|
2995
|
+
],
|
|
2996
|
+
[
|
|
2997
|
+
"j",
|
|
2998
|
+
"json",
|
|
2999
|
+
"return the lint results in json format"
|
|
3000
|
+
]
|
|
3001
|
+
],
|
|
3002
|
+
"description": "lint components in the development workspace",
|
|
3003
|
+
"extendedDescription": "",
|
|
3004
|
+
"group": "development",
|
|
3005
|
+
"private": false
|
|
3006
|
+
}
|
|
3007
|
+
]
|