@teambit/harmony.content.cli-reference 2.0.556 → 2.0.558
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.docs.mdx +1 -1
- package/cli-reference.json +172 -139
- package/cli-reference.mdx +17 -2
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +172 -139
- package/dist/cli-reference.mdx.js +158 -5
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1739416868289.js → preview-1739589589774.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -74,6 +74,87 @@
|
|
|
74
74
|
"group": "general",
|
|
75
75
|
"private": false
|
|
76
76
|
},
|
|
77
|
+
{
|
|
78
|
+
"name": "config",
|
|
79
|
+
"alias": "",
|
|
80
|
+
"options": [],
|
|
81
|
+
"description": "config management",
|
|
82
|
+
"extendedDescription": "https://bit.dev/reference/config/bit-config",
|
|
83
|
+
"group": "general",
|
|
84
|
+
"private": false,
|
|
85
|
+
"commands": [
|
|
86
|
+
{
|
|
87
|
+
"name": "set <key> <val>",
|
|
88
|
+
"alias": "",
|
|
89
|
+
"options": [
|
|
90
|
+
[
|
|
91
|
+
"l",
|
|
92
|
+
"local",
|
|
93
|
+
"set the configuration in the current scope (saved in .bit/scope.json)"
|
|
94
|
+
],
|
|
95
|
+
[
|
|
96
|
+
"t",
|
|
97
|
+
"local-track",
|
|
98
|
+
"set the configuration in the current workspace (saved in workspace.jsonc)"
|
|
99
|
+
]
|
|
100
|
+
],
|
|
101
|
+
"description": "set a configuration. default to save it globally",
|
|
102
|
+
"extendedDescription": "to set temporary configuration by env variable, prefix with \"BIT_CONFIG\", replace \".\" with \"_\" and change to upper case.\nfor example, \"user.token\" becomes \"BIT_CONFIG_USER_TOKEN\"",
|
|
103
|
+
"group": "ungrouped",
|
|
104
|
+
"private": false,
|
|
105
|
+
"skipWorkspace": true
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "del <key>",
|
|
109
|
+
"alias": "",
|
|
110
|
+
"options": [
|
|
111
|
+
[
|
|
112
|
+
"o",
|
|
113
|
+
"origin <origin>",
|
|
114
|
+
"default to delete whenever it found first. specify to delete specifically from the following: [scope, workspace, global]"
|
|
115
|
+
]
|
|
116
|
+
],
|
|
117
|
+
"description": "delete given key from global configuration",
|
|
118
|
+
"extendedDescription": "",
|
|
119
|
+
"group": "ungrouped",
|
|
120
|
+
"private": false
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "get <key>",
|
|
124
|
+
"alias": "",
|
|
125
|
+
"options": [],
|
|
126
|
+
"description": "get a value from global configuration",
|
|
127
|
+
"extendedDescription": "",
|
|
128
|
+
"group": "ungrouped",
|
|
129
|
+
"private": false
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"name": "list",
|
|
133
|
+
"alias": "",
|
|
134
|
+
"options": [
|
|
135
|
+
[
|
|
136
|
+
"o",
|
|
137
|
+
"origin <origin>",
|
|
138
|
+
"list configuration specifically from the following: [scope, workspace, global]"
|
|
139
|
+
],
|
|
140
|
+
[
|
|
141
|
+
"d",
|
|
142
|
+
"detailed",
|
|
143
|
+
"list all configuration(s) with the origin"
|
|
144
|
+
],
|
|
145
|
+
[
|
|
146
|
+
"j",
|
|
147
|
+
"json",
|
|
148
|
+
"output as JSON"
|
|
149
|
+
]
|
|
150
|
+
],
|
|
151
|
+
"description": "list all configuration(s)",
|
|
152
|
+
"extendedDescription": "",
|
|
153
|
+
"group": "ungrouped",
|
|
154
|
+
"private": false
|
|
155
|
+
}
|
|
156
|
+
]
|
|
157
|
+
},
|
|
77
158
|
{
|
|
78
159
|
"name": "doctor [diagnosis-name]",
|
|
79
160
|
"alias": "",
|
|
@@ -200,145 +281,6 @@
|
|
|
200
281
|
"private": false,
|
|
201
282
|
"skipWorkspace": true
|
|
202
283
|
},
|
|
203
|
-
{
|
|
204
|
-
"name": "globals",
|
|
205
|
-
"alias": "",
|
|
206
|
-
"options": [
|
|
207
|
-
[
|
|
208
|
-
"j",
|
|
209
|
-
"json",
|
|
210
|
-
"json format"
|
|
211
|
-
]
|
|
212
|
-
],
|
|
213
|
-
"description": "list all globals",
|
|
214
|
-
"extendedDescription": "",
|
|
215
|
-
"group": "workspace",
|
|
216
|
-
"private": false
|
|
217
|
-
},
|
|
218
|
-
{
|
|
219
|
-
"name": "system <sub-command>",
|
|
220
|
-
"alias": "",
|
|
221
|
-
"options": [],
|
|
222
|
-
"description": "system operations",
|
|
223
|
-
"extendedDescription": "",
|
|
224
|
-
"group": "workspace",
|
|
225
|
-
"private": false,
|
|
226
|
-
"commands": [
|
|
227
|
-
{
|
|
228
|
-
"name": "log",
|
|
229
|
-
"alias": "",
|
|
230
|
-
"options": [],
|
|
231
|
-
"description": "print debug.log to the screen",
|
|
232
|
-
"extendedDescription": "",
|
|
233
|
-
"group": "workspace",
|
|
234
|
-
"private": false
|
|
235
|
-
},
|
|
236
|
-
{
|
|
237
|
-
"name": "tail-log",
|
|
238
|
-
"alias": "",
|
|
239
|
-
"options": [],
|
|
240
|
-
"description": "print the log file to the screen as it is being written",
|
|
241
|
-
"extendedDescription": "similar to linux \"tail -f\" command",
|
|
242
|
-
"group": "workspace",
|
|
243
|
-
"private": false
|
|
244
|
-
}
|
|
245
|
-
]
|
|
246
|
-
},
|
|
247
|
-
{
|
|
248
|
-
"name": "config",
|
|
249
|
-
"alias": "",
|
|
250
|
-
"options": [],
|
|
251
|
-
"description": "global config management",
|
|
252
|
-
"extendedDescription": "https://bit.dev/reference/config/bit-config",
|
|
253
|
-
"group": "general",
|
|
254
|
-
"private": false,
|
|
255
|
-
"commands": [
|
|
256
|
-
{
|
|
257
|
-
"name": "set <key> <val>",
|
|
258
|
-
"alias": "",
|
|
259
|
-
"options": [],
|
|
260
|
-
"description": "set a global configuration",
|
|
261
|
-
"extendedDescription": "to set temporary configuration by env variable, prefix with \"BIT_CONFIG\", replace \".\" with \"_\" and change to upper case.\nfor example, \"user.token\" becomes \"BIT_CONFIG_USER_TOKEN\"",
|
|
262
|
-
"group": "ungrouped",
|
|
263
|
-
"private": false,
|
|
264
|
-
"skipWorkspace": true
|
|
265
|
-
},
|
|
266
|
-
{
|
|
267
|
-
"name": "del <key>",
|
|
268
|
-
"alias": "",
|
|
269
|
-
"options": [],
|
|
270
|
-
"description": "delete given key from global configuration",
|
|
271
|
-
"extendedDescription": "",
|
|
272
|
-
"group": "ungrouped",
|
|
273
|
-
"private": false
|
|
274
|
-
},
|
|
275
|
-
{
|
|
276
|
-
"name": "get <key>",
|
|
277
|
-
"alias": "",
|
|
278
|
-
"options": [],
|
|
279
|
-
"description": "get a value from global configuration",
|
|
280
|
-
"extendedDescription": "",
|
|
281
|
-
"group": "ungrouped",
|
|
282
|
-
"private": false
|
|
283
|
-
},
|
|
284
|
-
{
|
|
285
|
-
"name": "list",
|
|
286
|
-
"alias": "",
|
|
287
|
-
"options": [],
|
|
288
|
-
"description": "list all configuration(s)",
|
|
289
|
-
"extendedDescription": "",
|
|
290
|
-
"group": "ungrouped",
|
|
291
|
-
"private": false
|
|
292
|
-
}
|
|
293
|
-
]
|
|
294
|
-
},
|
|
295
|
-
{
|
|
296
|
-
"name": "remote",
|
|
297
|
-
"alias": "",
|
|
298
|
-
"options": [
|
|
299
|
-
[
|
|
300
|
-
"g",
|
|
301
|
-
"global",
|
|
302
|
-
"see globally configured remotes"
|
|
303
|
-
]
|
|
304
|
-
],
|
|
305
|
-
"description": "manage set of tracked bit scope(s)",
|
|
306
|
-
"extendedDescription": "",
|
|
307
|
-
"group": "collaborate",
|
|
308
|
-
"private": false,
|
|
309
|
-
"commands": [
|
|
310
|
-
{
|
|
311
|
-
"name": "add <url>",
|
|
312
|
-
"alias": "",
|
|
313
|
-
"options": [
|
|
314
|
-
[
|
|
315
|
-
"g",
|
|
316
|
-
"global",
|
|
317
|
-
"configure a remote bit scope"
|
|
318
|
-
]
|
|
319
|
-
],
|
|
320
|
-
"description": "add a bare-scope as a remote",
|
|
321
|
-
"extendedDescription": "supported protocols are [file, http].\nfor example: \"http://localhost:3000\", \"file:///tmp/local-scope\"",
|
|
322
|
-
"group": "ungrouped",
|
|
323
|
-
"private": false
|
|
324
|
-
},
|
|
325
|
-
{
|
|
326
|
-
"name": "del <name>",
|
|
327
|
-
"alias": "",
|
|
328
|
-
"options": [
|
|
329
|
-
[
|
|
330
|
-
"g",
|
|
331
|
-
"global",
|
|
332
|
-
"remove a globally configured remote scope"
|
|
333
|
-
]
|
|
334
|
-
],
|
|
335
|
-
"description": "remove a tracked bit remote",
|
|
336
|
-
"extendedDescription": "",
|
|
337
|
-
"group": "ungrouped",
|
|
338
|
-
"private": false
|
|
339
|
-
}
|
|
340
|
-
]
|
|
341
|
-
},
|
|
342
284
|
{
|
|
343
285
|
"name": "show <component-name>",
|
|
344
286
|
"alias": "",
|
|
@@ -531,6 +473,97 @@
|
|
|
531
473
|
}
|
|
532
474
|
]
|
|
533
475
|
},
|
|
476
|
+
{
|
|
477
|
+
"name": "globals",
|
|
478
|
+
"alias": "",
|
|
479
|
+
"options": [
|
|
480
|
+
[
|
|
481
|
+
"j",
|
|
482
|
+
"json",
|
|
483
|
+
"json format"
|
|
484
|
+
]
|
|
485
|
+
],
|
|
486
|
+
"description": "list all globals",
|
|
487
|
+
"extendedDescription": "",
|
|
488
|
+
"group": "workspace",
|
|
489
|
+
"private": false
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"name": "system <sub-command>",
|
|
493
|
+
"alias": "",
|
|
494
|
+
"options": [],
|
|
495
|
+
"description": "system operations",
|
|
496
|
+
"extendedDescription": "",
|
|
497
|
+
"group": "workspace",
|
|
498
|
+
"private": false,
|
|
499
|
+
"commands": [
|
|
500
|
+
{
|
|
501
|
+
"name": "log",
|
|
502
|
+
"alias": "",
|
|
503
|
+
"options": [],
|
|
504
|
+
"description": "print debug.log to the screen",
|
|
505
|
+
"extendedDescription": "",
|
|
506
|
+
"group": "workspace",
|
|
507
|
+
"private": false
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "tail-log",
|
|
511
|
+
"alias": "",
|
|
512
|
+
"options": [],
|
|
513
|
+
"description": "print the log file to the screen as it is being written",
|
|
514
|
+
"extendedDescription": "similar to linux \"tail -f\" command",
|
|
515
|
+
"group": "workspace",
|
|
516
|
+
"private": false
|
|
517
|
+
}
|
|
518
|
+
]
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
"name": "remote",
|
|
522
|
+
"alias": "",
|
|
523
|
+
"options": [
|
|
524
|
+
[
|
|
525
|
+
"g",
|
|
526
|
+
"global",
|
|
527
|
+
"see globally configured remotes"
|
|
528
|
+
]
|
|
529
|
+
],
|
|
530
|
+
"description": "manage set of tracked bit scope(s)",
|
|
531
|
+
"extendedDescription": "",
|
|
532
|
+
"group": "collaborate",
|
|
533
|
+
"private": false,
|
|
534
|
+
"commands": [
|
|
535
|
+
{
|
|
536
|
+
"name": "add <url>",
|
|
537
|
+
"alias": "",
|
|
538
|
+
"options": [
|
|
539
|
+
[
|
|
540
|
+
"g",
|
|
541
|
+
"global",
|
|
542
|
+
"configure a remote bit scope"
|
|
543
|
+
]
|
|
544
|
+
],
|
|
545
|
+
"description": "add a bare-scope as a remote",
|
|
546
|
+
"extendedDescription": "supported protocols are [file, http].\nfor example: \"http://localhost:3000\", \"file:///tmp/local-scope\"",
|
|
547
|
+
"group": "ungrouped",
|
|
548
|
+
"private": false
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
"name": "del <name>",
|
|
552
|
+
"alias": "",
|
|
553
|
+
"options": [
|
|
554
|
+
[
|
|
555
|
+
"g",
|
|
556
|
+
"global",
|
|
557
|
+
"remove a globally configured remote scope"
|
|
558
|
+
]
|
|
559
|
+
],
|
|
560
|
+
"description": "remove a tracked bit remote",
|
|
561
|
+
"extendedDescription": "",
|
|
562
|
+
"group": "ungrouped",
|
|
563
|
+
"private": false
|
|
564
|
+
}
|
|
565
|
+
]
|
|
566
|
+
},
|
|
534
567
|
{
|
|
535
568
|
"name": "graph [id]",
|
|
536
569
|
"alias": "",
|
package/cli-reference.mdx
CHANGED
|
@@ -409,7 +409,7 @@ The following gets removed by this command:
|
|
|
409
409
|
|
|
410
410
|
## config
|
|
411
411
|
|
|
412
|
-
**Description**:
|
|
412
|
+
**Description**: config management
|
|
413
413
|
https://bit.dev/reference/config/bit-config
|
|
414
414
|
|
|
415
415
|
`bit config`
|
|
@@ -418,16 +418,25 @@ https://bit.dev/reference/config/bit-config
|
|
|
418
418
|
|
|
419
419
|
**Usage**: `config set <key> <val>`
|
|
420
420
|
|
|
421
|
-
**Description**: set a
|
|
421
|
+
**Description**: set a configuration. default to save it globally
|
|
422
422
|
to set temporary configuration by env variable, prefix with "BIT*CONFIG", replace "." with "*" and change to upper case.
|
|
423
423
|
for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"
|
|
424
424
|
|
|
425
|
+
| **Option** | **Option alias** | **Description** |
|
|
426
|
+
| --------------- | :--------------: | ------------------------------------------------------------------------- |
|
|
427
|
+
| `--local` | `-l` | set the configuration in the current scope (saved in .bit/scope.json) |
|
|
428
|
+
| `--local-track` | `-t` | set the configuration in the current workspace (saved in workspace.jsonc) |
|
|
429
|
+
|
|
425
430
|
### config del
|
|
426
431
|
|
|
427
432
|
**Usage**: `config del <key>`
|
|
428
433
|
|
|
429
434
|
**Description**: delete given key from global configuration
|
|
430
435
|
|
|
436
|
+
| **Option** | **Option alias** | **Description** |
|
|
437
|
+
| ------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------ |
|
|
438
|
+
| `--origin <origin>` | `-o` | default to delete whenever it found first. specify to delete specifically from the following: [scope, workspace, global] |
|
|
439
|
+
|
|
431
440
|
### config get
|
|
432
441
|
|
|
433
442
|
**Usage**: `config get <key>`
|
|
@@ -440,6 +449,12 @@ for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"
|
|
|
440
449
|
|
|
441
450
|
**Description**: list all configuration(s)
|
|
442
451
|
|
|
452
|
+
| **Option** | **Option alias** | **Description** |
|
|
453
|
+
| ------------------- | :--------------: | ------------------------------------------------------------------------------ |
|
|
454
|
+
| `--origin <origin>` | `-o` | list configuration specifically from the following: [scope, workspace, global] |
|
|
455
|
+
| `--detailed` | `-d` | list all configuration(s) with the origin |
|
|
456
|
+
| `--json` | `-j` | output as JSON |
|
|
457
|
+
|
|
443
458
|
---
|
|
444
459
|
|
|
445
460
|
## create
|