@teambit/harmony.content.cli-reference 1.95.48 → 1.95.51

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.
Files changed (9) hide show
  1. package/cli-reference.json +133 -23
  2. package/cli-reference.mdx +47 -6
  3. package/dist/cli-reference.json +133 -23
  4. package/dist/cli-reference.mdx.js +200 -8
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.51.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1659151732866.js → preview-1659756525406.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.48.tgz +0 -0
package/dist/cli-reference.mdx.js CHANGED
@@ -199,7 +199,90 @@ function MDXContent(_ref) {
199
199
  }, "-j")), (0, _react2.mdx)("td", {
200
200
  parentName: "tr",
201
201
  "align": null
202
- }, "return the component data in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "artifacts"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
202
+ }, "return the component data in json format")))), (0, _react2.mdx)("h3", null, "app run"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
203
+ parentName: "p"
204
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
205
+ parentName: "p"
206
+ }, "app run <app-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
207
+ parentName: "p"
208
+ }, "Description"), ": run an app (independent of bit's dev server)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
209
+ parentName: "table"
210
+ }, (0, _react2.mdx)("tr", {
211
+ parentName: "thead"
212
+ }, (0, _react2.mdx)("th", {
213
+ parentName: "tr",
214
+ "align": null
215
+ }, (0, _react2.mdx)("strong", {
216
+ parentName: "th"
217
+ }, "Option")), (0, _react2.mdx)("th", {
218
+ parentName: "tr",
219
+ "align": "center"
220
+ }, (0, _react2.mdx)("strong", {
221
+ parentName: "th"
222
+ }, "Option alias")), (0, _react2.mdx)("th", {
223
+ parentName: "tr",
224
+ "align": null
225
+ }, (0, _react2.mdx)("strong", {
226
+ parentName: "th"
227
+ }, "Description")))), (0, _react2.mdx)("tbody", {
228
+ parentName: "table"
229
+ }, (0, _react2.mdx)("tr", {
230
+ parentName: "tbody"
231
+ }, (0, _react2.mdx)("td", {
232
+ parentName: "tr",
233
+ "align": null
234
+ }, (0, _react2.mdx)("inlineCode", {
235
+ parentName: "td"
236
+ }, "--dev")), (0, _react2.mdx)("td", {
237
+ parentName: "tr",
238
+ "align": "center"
239
+ }, (0, _react2.mdx)("inlineCode", {
240
+ parentName: "td"
241
+ }, "-d")), (0, _react2.mdx)("td", {
242
+ parentName: "tr",
243
+ "align": null
244
+ }, "start the application in dev mode.")), (0, _react2.mdx)("tr", {
245
+ parentName: "tbody"
246
+ }, (0, _react2.mdx)("td", {
247
+ parentName: "tr",
248
+ "align": null
249
+ }, (0, _react2.mdx)("inlineCode", {
250
+ parentName: "td"
251
+ }, "--verbose")), (0, _react2.mdx)("td", {
252
+ parentName: "tr",
253
+ "align": "center"
254
+ }, (0, _react2.mdx)("inlineCode", {
255
+ parentName: "td"
256
+ }, "-v")), (0, _react2.mdx)("td", {
257
+ parentName: "tr",
258
+ "align": null
259
+ }, "showing verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
260
+ parentName: "tbody"
261
+ }, (0, _react2.mdx)("td", {
262
+ parentName: "tr",
263
+ "align": null
264
+ }, (0, _react2.mdx)("inlineCode", {
265
+ parentName: "td"
266
+ }, "--skip-watch")), (0, _react2.mdx)("td", {
267
+ parentName: "tr",
268
+ "align": "center"
269
+ }), (0, _react2.mdx)("td", {
270
+ parentName: "tr",
271
+ "align": null
272
+ }, "avoid running the watch process that compiles components in the background")), (0, _react2.mdx)("tr", {
273
+ parentName: "tbody"
274
+ }, (0, _react2.mdx)("td", {
275
+ parentName: "tr",
276
+ "align": null
277
+ }, (0, _react2.mdx)("inlineCode", {
278
+ parentName: "td"
279
+ }, "--ssr")), (0, _react2.mdx)("td", {
280
+ parentName: "tr",
281
+ "align": "center"
282
+ }), (0, _react2.mdx)("td", {
283
+ parentName: "tr",
284
+ "align": null
285
+ }, "run app in server side rendering mode.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "artifacts"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
203
286
  parentName: "p"
204
287
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
205
288
  parentName: "p"
@@ -399,7 +482,43 @@ function MDXContent(_ref) {
399
482
  parentName: "p"
400
483
  }, "aspect set <pattern> <aspect-id> [config]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
401
484
  parentName: "p"
402
- }, "Description"), ": set components with an aspect to extend their development tools, metadata and (possibly) artifacts"), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
485
+ }, "Description"), ": set components with an aspect to extend their development tools, metadata and (possibly) artifacts"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
486
+ parentName: "table"
487
+ }, (0, _react2.mdx)("tr", {
488
+ parentName: "thead"
489
+ }, (0, _react2.mdx)("th", {
490
+ parentName: "tr",
491
+ "align": null
492
+ }, (0, _react2.mdx)("strong", {
493
+ parentName: "th"
494
+ }, "Option")), (0, _react2.mdx)("th", {
495
+ parentName: "tr",
496
+ "align": "center"
497
+ }, (0, _react2.mdx)("strong", {
498
+ parentName: "th"
499
+ }, "Option alias")), (0, _react2.mdx)("th", {
500
+ parentName: "tr",
501
+ "align": null
502
+ }, (0, _react2.mdx)("strong", {
503
+ parentName: "th"
504
+ }, "Description")))), (0, _react2.mdx)("tbody", {
505
+ parentName: "table"
506
+ }, (0, _react2.mdx)("tr", {
507
+ parentName: "tbody"
508
+ }, (0, _react2.mdx)("td", {
509
+ parentName: "tr",
510
+ "align": null
511
+ }, (0, _react2.mdx)("inlineCode", {
512
+ parentName: "td"
513
+ }, "--merge")), (0, _react2.mdx)("td", {
514
+ parentName: "tr",
515
+ "align": "center"
516
+ }, (0, _react2.mdx)("inlineCode", {
517
+ parentName: "td"
518
+ }, "-m")), (0, _react2.mdx)("td", {
519
+ parentName: "tr",
520
+ "align": null
521
+ }, "merge with an existing config if exits. (by default, it replaces the config)")))), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
403
522
  parentName: "p"
404
523
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
405
524
  parentName: "p"
@@ -1498,13 +1617,25 @@ function MDXContent(_ref) {
1498
1617
  "align": null
1499
1618
  }, "set the component's environment. (overrides the env from variants and the template)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1500
1619
  parentName: "p"
1620
+ }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
1621
+ parentName: "p"
1622
+ }, "deps"), (0, _react2.mdx)("br", {
1623
+ parentName: "p"
1624
+ }), "\n", (0, _react2.mdx)("strong", {
1625
+ parentName: "p"
1501
1626
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
1502
1627
  parentName: "p"
1503
1628
  }), "\n", (0, _react2.mdx)("strong", {
1504
1629
  parentName: "p"
1505
- }, "Description"), ": EXPERIMENTAL. show direct and indirect dependencies of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1630
+ }, "Description"), ": manage dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1631
+ parentName: "p"
1632
+ }, "bit dependencies <sub-command>")), (0, _react2.mdx)("h3", null, "dependencies get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1633
+ parentName: "p"
1634
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1635
+ parentName: "p"
1636
+ }, "dependencies get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1506
1637
  parentName: "p"
1507
- }, "bit dependencies <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1638
+ }, "Description"), ": show direct and indirect dependencies of the given component"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1508
1639
  parentName: "table"
1509
1640
  }, (0, _react2.mdx)("tr", {
1510
1641
  parentName: "thead"
@@ -1540,14 +1671,47 @@ function MDXContent(_ref) {
1540
1671
  }, "-t")), (0, _react2.mdx)("td", {
1541
1672
  parentName: "tr",
1542
1673
  "align": null
1543
- }, "render dependencies as a tree, similar to \"npm ls\"")), (0, _react2.mdx)("tr", {
1674
+ }, "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\"")))), (0, _react2.mdx)("h3", null, "dependencies debug"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1675
+ parentName: "p"
1676
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1677
+ parentName: "p"
1678
+ }, "dependencies debug <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1679
+ parentName: "p"
1680
+ }, "Description"), ": show the immediate dependencies and how their versions were determined"), (0, _react2.mdx)("h3", null, "dependencies set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1681
+ parentName: "p"
1682
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1683
+ parentName: "p"
1684
+ }, "dependencies set <component-pattern> <package>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1685
+ parentName: "p"
1686
+ }, "Description"), ": set a dependency to component(s)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1687
+ parentName: "table"
1688
+ }, (0, _react2.mdx)("tr", {
1689
+ parentName: "thead"
1690
+ }, (0, _react2.mdx)("th", {
1691
+ parentName: "tr",
1692
+ "align": null
1693
+ }, (0, _react2.mdx)("strong", {
1694
+ parentName: "th"
1695
+ }, "Option")), (0, _react2.mdx)("th", {
1696
+ parentName: "tr",
1697
+ "align": "center"
1698
+ }, (0, _react2.mdx)("strong", {
1699
+ parentName: "th"
1700
+ }, "Option alias")), (0, _react2.mdx)("th", {
1701
+ parentName: "tr",
1702
+ "align": null
1703
+ }, (0, _react2.mdx)("strong", {
1704
+ parentName: "th"
1705
+ }, "Description")))), (0, _react2.mdx)("tbody", {
1706
+ parentName: "table"
1707
+ }, (0, _react2.mdx)("tr", {
1544
1708
  parentName: "tbody"
1545
1709
  }, (0, _react2.mdx)("td", {
1546
1710
  parentName: "tr",
1547
1711
  "align": null
1548
1712
  }, (0, _react2.mdx)("inlineCode", {
1549
1713
  parentName: "td"
1550
- }, "--debug")), (0, _react2.mdx)("td", {
1714
+ }, "--dev")), (0, _react2.mdx)("td", {
1551
1715
  parentName: "tr",
1552
1716
  "align": "center"
1553
1717
  }, (0, _react2.mdx)("inlineCode", {
@@ -1555,7 +1719,22 @@ function MDXContent(_ref) {
1555
1719
  }, "-d")), (0, _react2.mdx)("td", {
1556
1720
  parentName: "tr",
1557
1721
  "align": null
1558
- }, "show the immediate dependencies and how their version was determined")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1722
+ }, "add to the devDependencies")), (0, _react2.mdx)("tr", {
1723
+ parentName: "tbody"
1724
+ }, (0, _react2.mdx)("td", {
1725
+ parentName: "tr",
1726
+ "align": null
1727
+ }, (0, _react2.mdx)("inlineCode", {
1728
+ parentName: "td"
1729
+ }, "--peer")), (0, _react2.mdx)("td", {
1730
+ parentName: "tr",
1731
+ "align": "center"
1732
+ }, (0, _react2.mdx)("inlineCode", {
1733
+ parentName: "td"
1734
+ }, "-p")), (0, _react2.mdx)("td", {
1735
+ parentName: "tr",
1736
+ "align": null
1737
+ }, "add to the peerDependencies")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1559
1738
  parentName: "p"
1560
1739
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
1561
1740
  parentName: "p"
@@ -4461,7 +4640,20 @@ function MDXContent(_ref) {
4461
4640
  }), (0, _react2.mdx)("td", {
4462
4641
  parentName: "tr",
4463
4642
  "align": null
4464
- }, "avoid running the watch process that compiles components in the background")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "schema"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4643
+ }, "avoid running the watch process that compiles components in the background")), (0, _react2.mdx)("tr", {
4644
+ parentName: "tbody"
4645
+ }, (0, _react2.mdx)("td", {
4646
+ parentName: "tr",
4647
+ "align": null
4648
+ }, (0, _react2.mdx)("inlineCode", {
4649
+ parentName: "td"
4650
+ }, "--ssr")), (0, _react2.mdx)("td", {
4651
+ parentName: "tr",
4652
+ "align": "center"
4653
+ }), (0, _react2.mdx)("td", {
4654
+ parentName: "tr",
4655
+ "align": null
4656
+ }, "run app in server side rendering mode.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "schema"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4465
4657
  parentName: "p"
4466
4658
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4467
4659
  parentName: "p"