@teambit/harmony.content.cli-reference 2.0.556 → 2.0.557

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.
@@ -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": "",
@@ -2075,7 +2075,7 @@ function MDXContent(_ref) {
2075
2075
  parentName: "p"
2076
2076
  }, "bit completion")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2077
2077
  parentName: "p"
2078
- }, "Description"), ": global config management", (0, _react2.mdx)("br", {
2078
+ }, "Description"), ": config management", (0, _react2.mdx)("br", {
2079
2079
  parentName: "p"
2080
2080
  }), "\n", (0, _react2.mdx)("a", {
2081
2081
  parentName: "p",
@@ -2088,19 +2088,106 @@ function MDXContent(_ref) {
2088
2088
  parentName: "p"
2089
2089
  }, "config set <key> <val>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2090
2090
  parentName: "p"
2091
- }, "Description"), ": set a global configuration", (0, _react2.mdx)("br", {
2091
+ }, "Description"), ": set a configuration. default to save it globally", (0, _react2.mdx)("br", {
2092
2092
  parentName: "p"
2093
2093
  }), "\n", "to set temporary configuration by env variable, prefix with \"BIT", (0, _react2.mdx)("em", {
2094
2094
  parentName: "p"
2095
2095
  }, "CONFIG\", replace \".\" with \""), "\" and change to upper case.", (0, _react2.mdx)("br", {
2096
2096
  parentName: "p"
2097
- }), "\n", "for example, \"user.token\" becomes \"BIT_CONFIG_USER_TOKEN\""), (0, _react2.mdx)("h3", null, "config del"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2097
+ }), "\n", "for example, \"user.token\" becomes \"BIT_CONFIG_USER_TOKEN\""), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2098
+ parentName: "table"
2099
+ }, (0, _react2.mdx)("tr", {
2100
+ parentName: "thead"
2101
+ }, (0, _react2.mdx)("th", {
2102
+ parentName: "tr",
2103
+ "align": null
2104
+ }, (0, _react2.mdx)("strong", {
2105
+ parentName: "th"
2106
+ }, "Option")), (0, _react2.mdx)("th", {
2107
+ parentName: "tr",
2108
+ "align": "center"
2109
+ }, (0, _react2.mdx)("strong", {
2110
+ parentName: "th"
2111
+ }, "Option alias")), (0, _react2.mdx)("th", {
2112
+ parentName: "tr",
2113
+ "align": null
2114
+ }, (0, _react2.mdx)("strong", {
2115
+ parentName: "th"
2116
+ }, "Description")))), (0, _react2.mdx)("tbody", {
2117
+ parentName: "table"
2118
+ }, (0, _react2.mdx)("tr", {
2119
+ parentName: "tbody"
2120
+ }, (0, _react2.mdx)("td", {
2121
+ parentName: "tr",
2122
+ "align": null
2123
+ }, (0, _react2.mdx)("inlineCode", {
2124
+ parentName: "td"
2125
+ }, "--local")), (0, _react2.mdx)("td", {
2126
+ parentName: "tr",
2127
+ "align": "center"
2128
+ }, (0, _react2.mdx)("inlineCode", {
2129
+ parentName: "td"
2130
+ }, "-l")), (0, _react2.mdx)("td", {
2131
+ parentName: "tr",
2132
+ "align": null
2133
+ }, "set the configuration in the current scope (saved in .bit/scope.json)")), (0, _react2.mdx)("tr", {
2134
+ parentName: "tbody"
2135
+ }, (0, _react2.mdx)("td", {
2136
+ parentName: "tr",
2137
+ "align": null
2138
+ }, (0, _react2.mdx)("inlineCode", {
2139
+ parentName: "td"
2140
+ }, "--local-track")), (0, _react2.mdx)("td", {
2141
+ parentName: "tr",
2142
+ "align": "center"
2143
+ }, (0, _react2.mdx)("inlineCode", {
2144
+ parentName: "td"
2145
+ }, "-t")), (0, _react2.mdx)("td", {
2146
+ parentName: "tr",
2147
+ "align": null
2148
+ }, "set the configuration in the current workspace (saved in workspace.jsonc)")))), (0, _react2.mdx)("h3", null, "config del"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2098
2149
  parentName: "p"
2099
2150
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2100
2151
  parentName: "p"
2101
2152
  }, "config del <key>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2102
2153
  parentName: "p"
2103
- }, "Description"), ": delete given key from global configuration"), (0, _react2.mdx)("h3", null, "config get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2154
+ }, "Description"), ": delete given key from global configuration"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2155
+ parentName: "table"
2156
+ }, (0, _react2.mdx)("tr", {
2157
+ parentName: "thead"
2158
+ }, (0, _react2.mdx)("th", {
2159
+ parentName: "tr",
2160
+ "align": null
2161
+ }, (0, _react2.mdx)("strong", {
2162
+ parentName: "th"
2163
+ }, "Option")), (0, _react2.mdx)("th", {
2164
+ parentName: "tr",
2165
+ "align": "center"
2166
+ }, (0, _react2.mdx)("strong", {
2167
+ parentName: "th"
2168
+ }, "Option alias")), (0, _react2.mdx)("th", {
2169
+ parentName: "tr",
2170
+ "align": null
2171
+ }, (0, _react2.mdx)("strong", {
2172
+ parentName: "th"
2173
+ }, "Description")))), (0, _react2.mdx)("tbody", {
2174
+ parentName: "table"
2175
+ }, (0, _react2.mdx)("tr", {
2176
+ parentName: "tbody"
2177
+ }, (0, _react2.mdx)("td", {
2178
+ parentName: "tr",
2179
+ "align": null
2180
+ }, (0, _react2.mdx)("inlineCode", {
2181
+ parentName: "td"
2182
+ }, "--origin <origin>")), (0, _react2.mdx)("td", {
2183
+ parentName: "tr",
2184
+ "align": "center"
2185
+ }, (0, _react2.mdx)("inlineCode", {
2186
+ parentName: "td"
2187
+ }, "-o")), (0, _react2.mdx)("td", {
2188
+ parentName: "tr",
2189
+ "align": null
2190
+ }, "default to delete whenever it found first. specify to delete specifically from the following: ", "[scope, workspace, global]")))), (0, _react2.mdx)("h3", null, "config get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2104
2191
  parentName: "p"
2105
2192
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2106
2193
  parentName: "p"
@@ -2112,7 +2199,73 @@ function MDXContent(_ref) {
2112
2199
  parentName: "p"
2113
2200
  }, "config list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2114
2201
  parentName: "p"
2115
- }, "Description"), ": list all configuration(s)"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "create"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2202
+ }, "Description"), ": list all configuration(s)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2203
+ parentName: "table"
2204
+ }, (0, _react2.mdx)("tr", {
2205
+ parentName: "thead"
2206
+ }, (0, _react2.mdx)("th", {
2207
+ parentName: "tr",
2208
+ "align": null
2209
+ }, (0, _react2.mdx)("strong", {
2210
+ parentName: "th"
2211
+ }, "Option")), (0, _react2.mdx)("th", {
2212
+ parentName: "tr",
2213
+ "align": "center"
2214
+ }, (0, _react2.mdx)("strong", {
2215
+ parentName: "th"
2216
+ }, "Option alias")), (0, _react2.mdx)("th", {
2217
+ parentName: "tr",
2218
+ "align": null
2219
+ }, (0, _react2.mdx)("strong", {
2220
+ parentName: "th"
2221
+ }, "Description")))), (0, _react2.mdx)("tbody", {
2222
+ parentName: "table"
2223
+ }, (0, _react2.mdx)("tr", {
2224
+ parentName: "tbody"
2225
+ }, (0, _react2.mdx)("td", {
2226
+ parentName: "tr",
2227
+ "align": null
2228
+ }, (0, _react2.mdx)("inlineCode", {
2229
+ parentName: "td"
2230
+ }, "--origin <origin>")), (0, _react2.mdx)("td", {
2231
+ parentName: "tr",
2232
+ "align": "center"
2233
+ }, (0, _react2.mdx)("inlineCode", {
2234
+ parentName: "td"
2235
+ }, "-o")), (0, _react2.mdx)("td", {
2236
+ parentName: "tr",
2237
+ "align": null
2238
+ }, "list configuration specifically from the following: ", "[scope, workspace, global]")), (0, _react2.mdx)("tr", {
2239
+ parentName: "tbody"
2240
+ }, (0, _react2.mdx)("td", {
2241
+ parentName: "tr",
2242
+ "align": null
2243
+ }, (0, _react2.mdx)("inlineCode", {
2244
+ parentName: "td"
2245
+ }, "--detailed")), (0, _react2.mdx)("td", {
2246
+ parentName: "tr",
2247
+ "align": "center"
2248
+ }, (0, _react2.mdx)("inlineCode", {
2249
+ parentName: "td"
2250
+ }, "-d")), (0, _react2.mdx)("td", {
2251
+ parentName: "tr",
2252
+ "align": null
2253
+ }, "list all configuration(s) with the origin")), (0, _react2.mdx)("tr", {
2254
+ parentName: "tbody"
2255
+ }, (0, _react2.mdx)("td", {
2256
+ parentName: "tr",
2257
+ "align": null
2258
+ }, (0, _react2.mdx)("inlineCode", {
2259
+ parentName: "td"
2260
+ }, "--json")), (0, _react2.mdx)("td", {
2261
+ parentName: "tr",
2262
+ "align": "center"
2263
+ }, (0, _react2.mdx)("inlineCode", {
2264
+ parentName: "td"
2265
+ }, "-j")), (0, _react2.mdx)("td", {
2266
+ parentName: "tr",
2267
+ "align": null
2268
+ }, "output as JSON")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "create"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2116
2269
  parentName: "p"
2117
2270
  }, "Description"), ": create a new component (source files and config) using a template."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2118
2271
  parentName: "p"