@teambit/harmony.content.cli-reference 1.95.28 → 1.95.31

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 +307 -124
  2. package/cli-reference.mdx +160 -148
  3. package/dist/cli-reference.json +307 -124
  4. package/dist/cli-reference.mdx.js +202 -125
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.31.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1654918011878.js → preview-1655436530187.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.28.tgz +0 -0
package/dist/cli-reference.mdx.js CHANGED
@@ -185,7 +185,7 @@ function MDXContent(_ref) {
185
185
  parentName: "p"
186
186
  }), "\n", (0, _react2.mdx)("strong", {
187
187
  parentName: "p"
188
- }, "Description"), ": manage applications"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
188
+ }, "Description"), ": Manages apps"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
189
189
  parentName: "p"
190
190
  }, "bit app <sub-command>")), (0, _react2.mdx)("h3", null, "app list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
191
191
  parentName: "p"
@@ -193,7 +193,7 @@ function MDXContent(_ref) {
193
193
  parentName: "p"
194
194
  }, "app list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
195
195
  parentName: "p"
196
- }, "Description"), ": list all registered applications"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
196
+ }, "Description"), ": list all registered apps"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
197
197
  parentName: "table"
198
198
  }, (0, _react2.mdx)("tr", {
199
199
  parentName: "thead"
@@ -336,13 +336,17 @@ function MDXContent(_ref) {
336
336
  parentName: "p"
337
337
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
338
338
  parentName: "p"
339
- }, "bit aspect list \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
339
+ }, "bit aspect list \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
340
+ parentName: "p"
341
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
340
342
  parentName: "p"
341
343
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
342
344
  parentName: "p"
343
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
345
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
346
+ parentName: "p"
347
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
344
348
  parentName: "p"
345
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
349
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
346
350
  parentName: "table"
347
351
  }, (0, _react2.mdx)("tr", {
348
352
  parentName: "thead"
@@ -451,13 +455,17 @@ function MDXContent(_ref) {
451
455
  parentName: "p"
452
456
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
453
457
  parentName: "p"
454
- }, "bit aspect set \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
458
+ }, "bit aspect set \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
459
+ parentName: "p"
460
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
455
461
  parentName: "p"
456
462
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
457
463
  parentName: "p"
458
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
464
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
459
465
  parentName: "p"
460
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
466
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
467
+ parentName: "p"
468
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
461
469
  parentName: "p"
462
470
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
463
471
  parentName: "p"
@@ -469,13 +477,17 @@ function MDXContent(_ref) {
469
477
  parentName: "p"
470
478
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
471
479
  parentName: "p"
472
- }, "bit aspect unset \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
480
+ }, "bit aspect unset \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
481
+ parentName: "p"
482
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
473
483
  parentName: "p"
474
484
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
475
485
  parentName: "p"
476
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
486
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
487
+ parentName: "p"
488
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
477
489
  parentName: "p"
478
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "aspect update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
490
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "aspect update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
479
491
  parentName: "p"
480
492
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
481
493
  parentName: "p"
@@ -489,13 +501,17 @@ function MDXContent(_ref) {
489
501
  parentName: "p"
490
502
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
491
503
  parentName: "p"
492
- }, "bit aspect update <aspect-id> \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
504
+ }, "bit aspect update <aspect-id> \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
505
+ parentName: "p"
506
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
493
507
  parentName: "p"
494
508
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
495
509
  parentName: "p"
496
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
510
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
511
+ parentName: "p"
512
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
497
513
  parentName: "p"
498
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, "examples:", (0, _react2.mdx)("br", {
514
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, "examples:", (0, _react2.mdx)("br", {
499
515
  parentName: "p"
500
516
  }), "\n", "\"bit aspect update scope.org/aspect '", (0, _react2.mdx)("strong", {
501
517
  parentName: "p"
@@ -512,7 +528,7 @@ function MDXContent(_ref) {
512
528
  parentName: "p"
513
529
  }, "Description"), ": run set of tasks for build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
514
530
  parentName: "p"
515
- }, "bit build [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
531
+ }, "bit build [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
516
532
  parentName: "table"
517
533
  }, (0, _react2.mdx)("tr", {
518
534
  parentName: "thead"
@@ -909,7 +925,7 @@ function MDXContent(_ref) {
909
925
  parentName: "p"
910
926
  }, "Description"), ": check typescript types"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
911
927
  parentName: "p"
912
- }, "bit check-types [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
928
+ }, "bit check-types [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
913
929
  parentName: "table"
914
930
  }, (0, _react2.mdx)("tr", {
915
931
  parentName: "thead"
@@ -1311,9 +1327,9 @@ function MDXContent(_ref) {
1311
1327
  parentName: "p"
1312
1328
  }), "\n", (0, _react2.mdx)("strong", {
1313
1329
  parentName: "p"
1314
- }, "Description"), ": compile components in the development workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1330
+ }, "Description"), ": compile components in the workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1315
1331
  parentName: "p"
1316
- }, "bit compile [component...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1332
+ }, "bit compile [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1317
1333
  parentName: "table"
1318
1334
  }, (0, _react2.mdx)("tr", {
1319
1335
  parentName: "thead"
@@ -1489,9 +1505,9 @@ function MDXContent(_ref) {
1489
1505
  parentName: "p"
1490
1506
  }), "\n", (0, _react2.mdx)("strong", {
1491
1507
  parentName: "p"
1492
- }, "Description"), ": create a new component from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1508
+ }, "Description"), ": create a new component (source files and config) using a template."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1493
1509
  parentName: "p"
1494
- }, "bit create <templateName> <componentNames...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1510
+ }, "bit create <template-name> <component-names...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1495
1511
  parentName: "table"
1496
1512
  }, (0, _react2.mdx)("tr", {
1497
1513
  parentName: "thead"
@@ -1848,13 +1864,17 @@ function MDXContent(_ref) {
1848
1864
  parentName: "p"
1849
1865
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
1850
1866
  parentName: "p"
1851
- }, "bit eject \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1867
+ }, "bit eject \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
1868
+ parentName: "p"
1869
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1852
1870
  parentName: "p"
1853
1871
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
1854
1872
  parentName: "p"
1855
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
1873
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
1856
1874
  parentName: "p"
1857
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1875
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
1876
+ parentName: "p"
1877
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1858
1878
  parentName: "p"
1859
1879
  }, "bit eject <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1860
1880
  parentName: "table"
@@ -1934,13 +1954,17 @@ function MDXContent(_ref) {
1934
1954
  parentName: "p"
1935
1955
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
1936
1956
  parentName: "p"
1937
- }, "bit eject-conf \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1957
+ }, "bit eject-conf \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
1958
+ parentName: "p"
1959
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1938
1960
  parentName: "p"
1939
1961
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
1940
1962
  parentName: "p"
1941
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
1963
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
1942
1964
  parentName: "p"
1943
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1965
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
1966
+ parentName: "p"
1967
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1944
1968
  parentName: "p"
1945
1969
  }, "bit eject-conf <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1946
1970
  parentName: "table"
@@ -2005,7 +2029,7 @@ function MDXContent(_ref) {
2005
2029
  parentName: "p"
2006
2030
  }), "\n", (0, _react2.mdx)("strong", {
2007
2031
  parentName: "p"
2008
- }, "Description"), ": list all components envs"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2032
+ }, "Description"), ": list all components maintained by the workspace and their corresponding envs"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2009
2033
  parentName: "p"
2010
2034
  }, "bit envs")), (0, _react2.mdx)("h3", null, "envs list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2011
2035
  parentName: "p"
@@ -2017,33 +2041,21 @@ function MDXContent(_ref) {
2017
2041
  parentName: "p"
2018
2042
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2019
2043
  parentName: "p"
2020
- }, "envs get <name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2044
+ }, "envs get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2021
2045
  parentName: "p"
2022
- }, "Description"), ": show component's env details"), (0, _react2.mdx)("h3", null, "envs set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2046
+ }, "Description"), ": show information about a component's env"), (0, _react2.mdx)("h3", null, "envs set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2023
2047
  parentName: "p"
2024
2048
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2025
2049
  parentName: "p"
2026
- }, "envs set <pattern> <env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2027
- parentName: "p"
2028
- }, "Description"), ": set an environment for component(s)", (0, _react2.mdx)("br", {
2029
- parentName: "p"
2030
- }), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
2031
- parentName: "p"
2032
- }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
2050
+ }, "envs set <component-pattern> <env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2033
2051
  parentName: "p"
2034
- }, "bit env set \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
2035
- parentName: "p"
2036
- }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
2037
- parentName: "p"
2038
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
2039
- parentName: "p"
2040
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "envs unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2052
+ }, "Description"), ": Sets one or more components with a development environment (env)"), (0, _react2.mdx)("h3", null, "envs unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2041
2053
  parentName: "p"
2042
2054
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2043
2055
  parentName: "p"
2044
- }, "envs unset <pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2056
+ }, "envs unset <component-pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2045
2057
  parentName: "p"
2046
- }, "Description"), ": unset an environment from component(s) that was set by \"bit env set\"", (0, _react2.mdx)("br", {
2058
+ }, "Description"), ": un-sets an env from components that were previously set by \"bit env set\" or by a component template", (0, _react2.mdx)("br", {
2047
2059
  parentName: "p"
2048
2060
  }), "\n", "keep in mind that this doesn't remove envs that are set in the variants.", (0, _react2.mdx)("br", {
2049
2061
  parentName: "p"
@@ -2055,17 +2067,21 @@ function MDXContent(_ref) {
2055
2067
  parentName: "p"
2056
2068
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
2057
2069
  parentName: "p"
2058
- }, "bit env unset \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
2070
+ }, "bit env unset \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
2071
+ parentName: "p"
2072
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
2059
2073
  parentName: "p"
2060
2074
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
2061
2075
  parentName: "p"
2062
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
2076
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
2063
2077
  parentName: "p"
2064
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "envs replace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2078
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
2079
+ parentName: "p"
2080
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "envs replace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2065
2081
  parentName: "p"
2066
2082
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2067
2083
  parentName: "p"
2068
- }, "envs replace <old-env> <new-env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2084
+ }, "envs replace <current-env> <new-env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2069
2085
  parentName: "p"
2070
2086
  }, "Description"), ": replace an existing env with another env for all components using the old env"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "export"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2071
2087
  parentName: "p"
@@ -2079,7 +2095,7 @@ function MDXContent(_ref) {
2079
2095
  parentName: "p"
2080
2096
  }), "\n", (0, _react2.mdx)("strong", {
2081
2097
  parentName: "p"
2082
- }, "Description"), ": Export components to a remote scope", (0, _react2.mdx)("br", {
2098
+ }, "Description"), ": export components from the workspace to remote scopes", (0, _react2.mdx)("br", {
2083
2099
  parentName: "p"
2084
2100
  }), "\n", "bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well", (0, _react2.mdx)("br", {
2085
2101
  parentName: "p"
@@ -2092,7 +2108,7 @@ function MDXContent(_ref) {
2092
2108
  parentName: "p"
2093
2109
  }), "\n", "you 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)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2094
2110
  parentName: "p"
2095
- }, "bit export [remote] [id...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2111
+ }, "bit export [remote] [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2096
2112
  parentName: "table"
2097
2113
  }, (0, _react2.mdx)("tr", {
2098
2114
  parentName: "thead"
@@ -2128,7 +2144,7 @@ function MDXContent(_ref) {
2128
2144
  }, "-e")), (0, _react2.mdx)("td", {
2129
2145
  parentName: "tr",
2130
2146
  "align": null
2131
- }, "replaces the exported components from the local scope with the corresponding packages")), (0, _react2.mdx)("tr", {
2147
+ }, "replace the exported components with their corresponding packages (to use these components without further maintaining them)")), (0, _react2.mdx)("tr", {
2132
2148
  parentName: "tbody"
2133
2149
  }, (0, _react2.mdx)("td", {
2134
2150
  parentName: "tr",
@@ -2143,7 +2159,7 @@ function MDXContent(_ref) {
2143
2159
  }, "-a")), (0, _react2.mdx)("td", {
2144
2160
  parentName: "tr",
2145
2161
  "align": null
2146
- }, "export all components include non-staged")), (0, _react2.mdx)("tr", {
2162
+ }, "export all components, including non-staged")), (0, _react2.mdx)("tr", {
2147
2163
  parentName: "tbody"
2148
2164
  }, (0, _react2.mdx)("td", {
2149
2165
  parentName: "tr",
@@ -2276,13 +2292,9 @@ function MDXContent(_ref) {
2276
2292
  parentName: "p"
2277
2293
  }), "\n", (0, _react2.mdx)("strong", {
2278
2294
  parentName: "p"
2279
- }, "Description"), ": EXPERIMENTAL. create a new component out of an existing one", (0, _react2.mdx)("br", {
2280
- parentName: "p"
2281
- }), "\n", "note that ", "[target-name]", " is the name only without the scope.", (0, _react2.mdx)("br", {
2282
- parentName: "p"
2283
- }), "\n", "to set the default-scope, please use --scope flag"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2295
+ }, "Description"), ": EXPERIMENTAL. create a new component out of an existing one (copies source files and config)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2284
2296
  parentName: "p"
2285
- }, "bit fork <source-id> [target-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2297
+ }, "bit fork <source-component-id> [target-component-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2286
2298
  parentName: "table"
2287
2299
  }, (0, _react2.mdx)("tr", {
2288
2300
  parentName: "thead"
@@ -2318,7 +2330,7 @@ function MDXContent(_ref) {
2318
2330
  }, "-s")), (0, _react2.mdx)("td", {
2319
2331
  parentName: "tr",
2320
2332
  "align": null
2321
- }, "default scope for the newly created component")), (0, _react2.mdx)("tr", {
2333
+ }, "default scope for the new component")), (0, _react2.mdx)("tr", {
2322
2334
  parentName: "tbody"
2323
2335
  }, (0, _react2.mdx)("td", {
2324
2336
  parentName: "tr",
@@ -2333,7 +2345,7 @@ function MDXContent(_ref) {
2333
2345
  }, "-p")), (0, _react2.mdx)("td", {
2334
2346
  parentName: "tr",
2335
2347
  "align": null
2336
- }, "relative path in the workspace. by default the path is ", (0, _react2.mdx)("inlineCode", {
2348
+ }, "relative path in the workspace for the new component. by default the path is ", (0, _react2.mdx)("inlineCode", {
2337
2349
  parentName: "td"
2338
2350
  }, "<scope>/<namespace>/<name>"))), (0, _react2.mdx)("tr", {
2339
2351
  parentName: "tbody"
@@ -2350,7 +2362,7 @@ function MDXContent(_ref) {
2350
2362
  }, "-r")), (0, _react2.mdx)("td", {
2351
2363
  parentName: "tr",
2352
2364
  "align": null
2353
- }, "change the source code of all components using the original component with the new package-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "format"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2365
+ }, "update the import/require statements in all dependent components (in the same workspace)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "format"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2354
2366
  parentName: "p"
2355
2367
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
2356
2368
  parentName: "p"
@@ -2571,7 +2583,7 @@ function MDXContent(_ref) {
2571
2583
  parentName: "p"
2572
2584
  }), "\n", (0, _react2.mdx)("strong", {
2573
2585
  parentName: "p"
2574
- }, "Description"), ": import components into your workspace", (0, _react2.mdx)("br", {
2586
+ }, "Description"), ": import components from remote scopes to the local workspace", (0, _react2.mdx)("br", {
2575
2587
  parentName: "p"
2576
2588
  }), "\n", (0, _react2.mdx)("a", {
2577
2589
  parentName: "p",
@@ -2580,7 +2592,7 @@ function MDXContent(_ref) {
2580
2592
  parentName: "p"
2581
2593
  }), "\n", "you can use a pattern for multiple ids, such as bit import \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2582
2594
  parentName: "p"
2583
- }, "bit import [ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2595
+ }, "bit import [component-ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2584
2596
  parentName: "table"
2585
2597
  }, (0, _react2.mdx)("tr", {
2586
2598
  parentName: "thead"
@@ -2616,7 +2628,7 @@ function MDXContent(_ref) {
2616
2628
  }, "-p")), (0, _react2.mdx)("td", {
2617
2629
  parentName: "tr",
2618
2630
  "align": null
2619
- }, "import components into a specific directory")), (0, _react2.mdx)("tr", {
2631
+ }, "import components into a specific directory (a relative path in the workspace)")), (0, _react2.mdx)("tr", {
2620
2632
  parentName: "tbody"
2621
2633
  }, (0, _react2.mdx)("td", {
2622
2634
  parentName: "tr",
@@ -2631,7 +2643,7 @@ function MDXContent(_ref) {
2631
2643
  }, "-o")), (0, _react2.mdx)("td", {
2632
2644
  parentName: "tr",
2633
2645
  "align": null
2634
- }, "import components objects only, don't write the components to the file system. This is a default behavior for import with no id")), (0, _react2.mdx)("tr", {
2646
+ }, "import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument")), (0, _react2.mdx)("tr", {
2635
2647
  parentName: "tbody"
2636
2648
  }, (0, _react2.mdx)("td", {
2637
2649
  parentName: "tr",
@@ -2676,7 +2688,7 @@ function MDXContent(_ref) {
2676
2688
  }, "-v")), (0, _react2.mdx)("td", {
2677
2689
  parentName: "tr",
2678
2690
  "align": null
2679
- }, "showing verbose output for inspection")), (0, _react2.mdx)("tr", {
2691
+ }, "show verbose output for inspection")), (0, _react2.mdx)("tr", {
2680
2692
  parentName: "tbody"
2681
2693
  }, (0, _react2.mdx)("td", {
2682
2694
  parentName: "tr",
@@ -2704,7 +2716,7 @@ function MDXContent(_ref) {
2704
2716
  }), (0, _react2.mdx)("td", {
2705
2717
  parentName: "tr",
2706
2718
  "align": null
2707
- }, "write the configuration file (component.json) of the component (harmony components only)")), (0, _react2.mdx)("tr", {
2719
+ }, "write the configuration file (component.json) of the component")), (0, _react2.mdx)("tr", {
2708
2720
  parentName: "tbody"
2709
2721
  }, (0, _react2.mdx)("td", {
2710
2722
  parentName: "tr",
@@ -3002,7 +3014,9 @@ function MDXContent(_ref) {
3002
3014
  parentName: "p"
3003
3015
  }), "\n", (0, _react2.mdx)("strong", {
3004
3016
  parentName: "p"
3005
- }, "Description"), ": install development workspace dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
3017
+ }, "Description"), ": installs workspace dependencies", (0, _react2.mdx)("br", {
3018
+ parentName: "p"
3019
+ }), "\n", "when no package is specified, all workspace dependencies are installed and all workspace components are imported."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
3006
3020
  parentName: "p"
3007
3021
  }, "bit install [packages...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
3008
3022
  parentName: "table"
@@ -3519,7 +3533,22 @@ function MDXContent(_ref) {
3519
3533
  }), (0, _react2.mdx)("td", {
3520
3534
  parentName: "tr",
3521
3535
  "align": null
3522
- }, "EXPERIMENTAL. show parents and lanes data")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "login"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
3536
+ }, "EXPERIMENTAL. show parents and lanes data")), (0, _react2.mdx)("tr", {
3537
+ parentName: "tbody"
3538
+ }, (0, _react2.mdx)("td", {
3539
+ parentName: "tr",
3540
+ "align": null
3541
+ }, (0, _react2.mdx)("inlineCode", {
3542
+ parentName: "td"
3543
+ }, "--json")), (0, _react2.mdx)("td", {
3544
+ parentName: "tr",
3545
+ "align": "center"
3546
+ }, (0, _react2.mdx)("inlineCode", {
3547
+ parentName: "td"
3548
+ }, "-j")), (0, _react2.mdx)("td", {
3549
+ parentName: "tr",
3550
+ "align": null
3551
+ }, "json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "login"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
3523
3552
  parentName: "p"
3524
3553
  }, "Workspace only"), ": no", (0, _react2.mdx)("br", {
3525
3554
  parentName: "p"
@@ -3835,9 +3864,9 @@ function MDXContent(_ref) {
3835
3864
  parentName: "p"
3836
3865
  }), "\n", (0, _react2.mdx)("strong", {
3837
3866
  parentName: "p"
3838
- }, "Description"), ": Create a new workspace from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
3867
+ }, "Description"), ": create a new workspace from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
3839
3868
  parentName: "p"
3840
- }, "bit new <templateName> <workspaceName>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
3869
+ }, "bit new <template-name> <workspace-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
3841
3870
  parentName: "table"
3842
3871
  }, (0, _react2.mdx)("tr", {
3843
3872
  parentName: "thead"
@@ -3865,7 +3894,7 @@ function MDXContent(_ref) {
3865
3894
  "align": null
3866
3895
  }, (0, _react2.mdx)("inlineCode", {
3867
3896
  parentName: "td"
3868
- }, "--aspect <string>")), (0, _react2.mdx)("td", {
3897
+ }, "--aspect <aspect-id>")), (0, _react2.mdx)("td", {
3869
3898
  parentName: "tr",
3870
3899
  "align": "center"
3871
3900
  }, (0, _react2.mdx)("inlineCode", {
@@ -3880,7 +3909,7 @@ function MDXContent(_ref) {
3880
3909
  "align": null
3881
3910
  }, (0, _react2.mdx)("inlineCode", {
3882
3911
  parentName: "td"
3883
- }, "--default-scope <string>")), (0, _react2.mdx)("td", {
3912
+ }, "--default-scope <scope-name>")), (0, _react2.mdx)("td", {
3884
3913
  parentName: "tr",
3885
3914
  "align": "center"
3886
3915
  }, (0, _react2.mdx)("inlineCode", {
@@ -3938,7 +3967,7 @@ function MDXContent(_ref) {
3938
3967
  "align": null
3939
3968
  }, (0, _react2.mdx)("inlineCode", {
3940
3969
  parentName: "td"
3941
- }, "--load-from <string>")), (0, _react2.mdx)("td", {
3970
+ }, "--load-from <path-to-template>")), (0, _react2.mdx)("td", {
3942
3971
  parentName: "tr",
3943
3972
  "align": "center"
3944
3973
  }), (0, _react2.mdx)("td", {
@@ -4054,7 +4083,28 @@ function MDXContent(_ref) {
4054
4083
  parentName: "p"
4055
4084
  }), "\n", (0, _react2.mdx)("strong", {
4056
4085
  parentName: "p"
4057
- }, "Description"), ": list the component ids matching the given pattern"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4086
+ }, "Description"), ": list the component ids matching the given pattern", (0, _react2.mdx)("br", {
4087
+ parentName: "p"
4088
+ }), "\n", "this command helps validating a pattern before using it in other commands.", (0, _react2.mdx)("br", {
4089
+ parentName: "p"
4090
+ }), "\n", "a pattern can be a simple component-id or component-name. e.g. \"ui/button\".", (0, _react2.mdx)("br", {
4091
+ parentName: "p"
4092
+ }), "\n", "a pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/", (0, _react2.mdx)("strong", {
4093
+ parentName: "p"
4094
+ }, "\".", (0, _react2.mdx)("br", {
4095
+ parentName: "strong"
4096
+ }), "to enter multiple patterns, separate them by a comma, e.g. \"ui/", (0, _react2.mdx)("em", {
4097
+ parentName: "strong"
4098
+ }, ", lib/"), "\"", (0, _react2.mdx)("br", {
4099
+ parentName: "strong"
4100
+ }), "to exclude, use \"!\". e.g. \"ui/"), ", !ui/button\"", (0, _react2.mdx)("br", {
4101
+ parentName: "p"
4102
+ }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4103
+ parentName: "p"
4104
+ }), "\n", "the matching algorithm is done by multimatch (@see ", (0, _react2.mdx)("a", {
4105
+ parentName: "p",
4106
+ "href": "https://github.com/sindresorhus/multimatch"
4107
+ }, "https://github.com/sindresorhus/multimatch"), ")"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4058
4108
  parentName: "p"
4059
4109
  }, "bit pattern <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4060
4110
  parentName: "table"
@@ -4473,9 +4523,9 @@ function MDXContent(_ref) {
4473
4523
  parentName: "p"
4474
4524
  }), "\n", (0, _react2.mdx)("strong", {
4475
4525
  parentName: "p"
4476
- }, "Description"), ": run an application"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4526
+ }, "Description"), ": run an app (independent of bit's dev server)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4477
4527
  parentName: "p"
4478
- }, "bit run <app>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4528
+ }, "bit run <app-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4479
4529
  parentName: "table"
4480
4530
  }, (0, _react2.mdx)("tr", {
4481
4531
  parentName: "thead"
@@ -4551,13 +4601,17 @@ function MDXContent(_ref) {
4551
4601
  parentName: "p"
4552
4602
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4553
4603
  parentName: "p"
4554
- }, "bit schema \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4604
+ }, "bit schema \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
4605
+ parentName: "p"
4606
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4555
4607
  parentName: "p"
4556
4608
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4557
4609
  parentName: "p"
4558
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
4610
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
4611
+ parentName: "p"
4612
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
4559
4613
  parentName: "p"
4560
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4614
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4561
4615
  parentName: "p"
4562
4616
  }, "bit schema <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4563
4617
  parentName: "table"
@@ -4601,35 +4655,37 @@ function MDXContent(_ref) {
4601
4655
  parentName: "p"
4602
4656
  }), "\n", (0, _react2.mdx)("strong", {
4603
4657
  parentName: "p"
4604
- }, "Description"), ": EXPERIMENTAL. manage scope-name"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4658
+ }, "Description"), ": EXPERIMENTAL. manage the scope-name for components"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4605
4659
  parentName: "p"
4606
4660
  }, "bit scope <sub-command>")), (0, _react2.mdx)("h3", null, "scope set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4607
4661
  parentName: "p"
4608
4662
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4609
4663
  parentName: "p"
4610
- }, "scope set <scope-name> [pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4664
+ }, "scope set <scope-name> [component-pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4611
4665
  parentName: "p"
4612
- }, "Description"), ": set the default-scope", (0, _react2.mdx)("br", {
4666
+ }, "Description"), ": Sets components with a default-scope. If no component is specified, sets the workspace with a default scope", (0, _react2.mdx)("br", {
4613
4667
  parentName: "p"
4614
- }), "\n", "set a new scope in the workspace.jsonc.", (0, _react2.mdx)("br", {
4615
- parentName: "p"
4616
- }), "\n", "if \"pattern\" is provided, the default-scope will be set to the new components matching the criteria."), (0, _react2.mdx)("p", null, "you can use a ", (0, _react2.mdx)("inlineCode", {
4668
+ }), "\n", "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose to default scope) only once it is versioned.'"), (0, _react2.mdx)("p", null, "you can use a ", (0, _react2.mdx)("inlineCode", {
4617
4669
  parentName: "p"
4618
4670
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4619
4671
  parentName: "p"
4620
- }, "bit scope set scope-name \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4672
+ }, "bit scope set scope-name \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
4673
+ parentName: "p"
4674
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4621
4675
  parentName: "p"
4622
4676
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4623
4677
  parentName: "p"
4624
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
4678
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
4679
+ parentName: "p"
4680
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
4625
4681
  parentName: "p"
4626
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "scope rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4682
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "scope rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4627
4683
  parentName: "p"
4628
4684
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4629
4685
  parentName: "p"
4630
- }, "scope rename <old-name> <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4686
+ }, "scope rename <current-scope-name> <new-scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4631
4687
  parentName: "p"
4632
- }, "Description"), ": rename a scope for components using the old-name, optionally change the dependencies source-code"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4688
+ }, "Description"), ": Renames the scope name for all components with the specified 'current scope name'"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4633
4689
  parentName: "table"
4634
4690
  }, (0, _react2.mdx)("tr", {
4635
4691
  parentName: "thead"
@@ -4709,9 +4765,9 @@ function MDXContent(_ref) {
4709
4765
  parentName: "p"
4710
4766
  }), "\n", (0, _react2.mdx)("strong", {
4711
4767
  parentName: "p"
4712
- }, "Description"), ": show a component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4768
+ }, "Description"), ": display the component's essential information"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4713
4769
  parentName: "p"
4714
- }, "bit show <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4770
+ }, "bit show <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4715
4771
  parentName: "table"
4716
4772
  }, (0, _react2.mdx)("tr", {
4717
4773
  parentName: "thead"
@@ -4747,7 +4803,7 @@ function MDXContent(_ref) {
4747
4803
  }, "-j")), (0, _react2.mdx)("td", {
4748
4804
  parentName: "tr",
4749
4805
  "align": null
4750
- }, "return the component data in json format")), (0, _react2.mdx)("tr", {
4806
+ }, "return the component data in a json format")), (0, _react2.mdx)("tr", {
4751
4807
  parentName: "tbody"
4752
4808
  }, (0, _react2.mdx)("td", {
4753
4809
  parentName: "tr",
@@ -4792,7 +4848,7 @@ function MDXContent(_ref) {
4792
4848
  }, "-c")), (0, _react2.mdx)("td", {
4793
4849
  parentName: "tr",
4794
4850
  "align": null
4795
- }, "compare current file system component to latest tagged component ", "[default=latest]", ". only works in legacy.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "start"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4851
+ }, "compare current file system component to the latest tagged component ", "[default=latest]", ". only works in legacy.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "start"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4796
4852
  parentName: "p"
4797
4853
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
4798
4854
  parentName: "p"
@@ -4804,7 +4860,7 @@ function MDXContent(_ref) {
4804
4860
  parentName: "p"
4805
4861
  }), "\n", (0, _react2.mdx)("strong", {
4806
4862
  parentName: "p"
4807
- }, "Description"), ": Start a dev environment for a workspace or a specific component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4863
+ }, "Description"), ": run the ui/development server"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4808
4864
  parentName: "p"
4809
4865
  }, "bit start [type] [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4810
4866
  parentName: "table"
@@ -4849,7 +4905,7 @@ function MDXContent(_ref) {
4849
4905
  "align": null
4850
4906
  }, (0, _react2.mdx)("inlineCode", {
4851
4907
  parentName: "td"
4852
- }, "--port [number]")), (0, _react2.mdx)("td", {
4908
+ }, "--port [port-number]")), (0, _react2.mdx)("td", {
4853
4909
  parentName: "tr",
4854
4910
  "align": "center"
4855
4911
  }, (0, _react2.mdx)("inlineCode", {
@@ -4887,7 +4943,7 @@ function MDXContent(_ref) {
4887
4943
  }, "-v")), (0, _react2.mdx)("td", {
4888
4944
  parentName: "tr",
4889
4945
  "align": null
4890
- }, "showing verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
4946
+ }, "show verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
4891
4947
  parentName: "tbody"
4892
4948
  }, (0, _react2.mdx)("td", {
4893
4949
  parentName: "tr",
@@ -4925,12 +4981,7 @@ function MDXContent(_ref) {
4925
4981
  parentName: "p"
4926
4982
  }), "\n", (0, _react2.mdx)("strong", {
4927
4983
  parentName: "p"
4928
- }, "Description"), ": show the working area component(s) status", (0, _react2.mdx)("br", {
4929
- parentName: "p"
4930
- }), "\n", (0, _react2.mdx)("a", {
4931
- parentName: "p",
4932
- "href": "https://bit.dev/docs/workspace/workspace-status"
4933
- }, "https://bit.dev/docs/workspace/workspace-status")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4984
+ }, "Description"), ": present the current status of components in the workspace, and notifies when issues are detected"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4934
4985
  parentName: "p"
4935
4986
  }, "bit status")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4936
4987
  parentName: "table"
@@ -4993,11 +5044,11 @@ function MDXContent(_ref) {
4993
5044
  parentName: "p"
4994
5045
  }), "\n", (0, _react2.mdx)("strong", {
4995
5046
  parentName: "p"
4996
- }, "Description"), ": record component changes and lock versions", (0, _react2.mdx)("br", {
5047
+ }, "Description"), ": create an immutable and exportable component snapshot, tagged with a release version.", (0, _react2.mdx)("br", {
4997
5048
  parentName: "p"
4998
- }), "\n", "if no ids are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
5049
+ }), "\n", "if no patterns are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
4999
5050
  parentName: "p"
5000
- }), "\n", "if component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag ", (0, _react2.mdx)("a", {
5051
+ }), "\n", "if patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag ", (0, _react2.mdx)("a", {
5001
5052
  parentName: "p",
5002
5053
  "href": "mailto:foo@1.0.0"
5003
5054
  }, "foo@1.0.0"), " bar@minor baz@major", (0, _react2.mdx)("br", {
@@ -5005,11 +5056,9 @@ function MDXContent(_ref) {
5005
5056
  }), "\n", (0, _react2.mdx)("a", {
5006
5057
  parentName: "p",
5007
5058
  "href": "https://bit.dev/components/tags"
5008
- }, "https://bit.dev/components/tags"), (0, _react2.mdx)("br", {
5009
- parentName: "p"
5010
- }), "\n", "you can use a pattern for multiple ids, such as bit tag \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5059
+ }, "https://bit.dev/components/tags")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5011
5060
  parentName: "p"
5012
- }, "bit tag [id...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5061
+ }, "bit tag [patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5013
5062
  parentName: "table"
5014
5063
  }, (0, _react2.mdx)("tr", {
5015
5064
  parentName: "thead"
@@ -5045,7 +5094,7 @@ function MDXContent(_ref) {
5045
5094
  }, "-m")), (0, _react2.mdx)("td", {
5046
5095
  parentName: "tr",
5047
5096
  "align": null
5048
- }, "log message describing the user changes")), (0, _react2.mdx)("tr", {
5097
+ }, "a log message describing latest changes")), (0, _react2.mdx)("tr", {
5049
5098
  parentName: "tbody"
5050
5099
  }, (0, _react2.mdx)("td", {
5051
5100
  parentName: "tr",
@@ -5071,7 +5120,7 @@ function MDXContent(_ref) {
5071
5120
  }), (0, _react2.mdx)("td", {
5072
5121
  parentName: "tr",
5073
5122
  "align": null
5074
- }, "EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim")), (0, _react2.mdx)("tr", {
5123
+ }, "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim).")), (0, _react2.mdx)("tr", {
5075
5124
  parentName: "tbody"
5076
5125
  }, (0, _react2.mdx)("td", {
5077
5126
  parentName: "tr",
@@ -5093,6 +5142,34 @@ function MDXContent(_ref) {
5093
5142
  "align": null
5094
5143
  }, (0, _react2.mdx)("inlineCode", {
5095
5144
  parentName: "td"
5145
+ }, "--increment <level>")), (0, _react2.mdx)("td", {
5146
+ parentName: "tr",
5147
+ "align": "center"
5148
+ }, (0, _react2.mdx)("inlineCode", {
5149
+ parentName: "td"
5150
+ }, "-l")), (0, _react2.mdx)("td", {
5151
+ parentName: "tr",
5152
+ "align": null
5153
+ }, "options are: ", "[major, premajor, minor, preminor, patch, prepatch, prerelease]", ", default to patch")), (0, _react2.mdx)("tr", {
5154
+ parentName: "tbody"
5155
+ }, (0, _react2.mdx)("td", {
5156
+ parentName: "tr",
5157
+ "align": null
5158
+ }, (0, _react2.mdx)("inlineCode", {
5159
+ parentName: "td"
5160
+ }, "--prerelease-id <id>")), (0, _react2.mdx)("td", {
5161
+ parentName: "tr",
5162
+ "align": "center"
5163
+ }), (0, _react2.mdx)("td", {
5164
+ parentName: "tr",
5165
+ "align": null
5166
+ }, "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")")), (0, _react2.mdx)("tr", {
5167
+ parentName: "tbody"
5168
+ }, (0, _react2.mdx)("td", {
5169
+ parentName: "tr",
5170
+ "align": null
5171
+ }, (0, _react2.mdx)("inlineCode", {
5172
+ parentName: "td"
5096
5173
  }, "--patch")), (0, _react2.mdx)("td", {
5097
5174
  parentName: "tr",
5098
5175
  "align": "center"
@@ -5101,7 +5178,7 @@ function MDXContent(_ref) {
5101
5178
  }, "-p")), (0, _react2.mdx)("td", {
5102
5179
  parentName: "tr",
5103
5180
  "align": null
5104
- }, "increment the patch version number")), (0, _react2.mdx)("tr", {
5181
+ }, "syntactic sugar for \"--increment patch\"")), (0, _react2.mdx)("tr", {
5105
5182
  parentName: "tbody"
5106
5183
  }, (0, _react2.mdx)("td", {
5107
5184
  parentName: "tr",
@@ -5114,7 +5191,7 @@ function MDXContent(_ref) {
5114
5191
  }), (0, _react2.mdx)("td", {
5115
5192
  parentName: "tr",
5116
5193
  "align": null
5117
- }, "increment the minor version number")), (0, _react2.mdx)("tr", {
5194
+ }, "syntactic sugar for \"--increment minor\"")), (0, _react2.mdx)("tr", {
5118
5195
  parentName: "tbody"
5119
5196
  }, (0, _react2.mdx)("td", {
5120
5197
  parentName: "tr",
@@ -5127,7 +5204,7 @@ function MDXContent(_ref) {
5127
5204
  }), (0, _react2.mdx)("td", {
5128
5205
  parentName: "tr",
5129
5206
  "align": null
5130
- }, "increment the major version number")), (0, _react2.mdx)("tr", {
5207
+ }, "syntactic sugar for \"--increment major\"")), (0, _react2.mdx)("tr", {
5131
5208
  parentName: "tbody"
5132
5209
  }, (0, _react2.mdx)("td", {
5133
5210
  parentName: "tr",
@@ -5140,7 +5217,7 @@ function MDXContent(_ref) {
5140
5217
  }), (0, _react2.mdx)("td", {
5141
5218
  parentName: "tr",
5142
5219
  "align": null
5143
- }, "tag components that their head is a snap (not a tag)")), (0, _react2.mdx)("tr", {
5220
+ }, "EXPERIMENTAL. tag components that their head is a snap (not a tag)")), (0, _react2.mdx)("tr", {
5144
5221
  parentName: "tbody"
5145
5222
  }, (0, _react2.mdx)("td", {
5146
5223
  parentName: "tr",
@@ -5153,7 +5230,7 @@ function MDXContent(_ref) {
5153
5230
  }), (0, _react2.mdx)("td", {
5154
5231
  parentName: "tr",
5155
5232
  "align": null
5156
- }, "EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)")), (0, _react2.mdx)("tr", {
5233
+ }, "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead")), (0, _react2.mdx)("tr", {
5157
5234
  parentName: "tbody"
5158
5235
  }, (0, _react2.mdx)("td", {
5159
5236
  parentName: "tr",
@@ -5339,9 +5416,9 @@ function MDXContent(_ref) {
5339
5416
  parentName: "p"
5340
5417
  }), "\n", (0, _react2.mdx)("strong", {
5341
5418
  parentName: "p"
5342
- }, "Description"), ": test set of components in your workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5419
+ }, "Description"), ": test components in the workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5343
5420
  parentName: "p"
5344
- }, "bit test [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5421
+ }, "bit test [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5345
5422
  parentName: "table"
5346
5423
  }, (0, _react2.mdx)("tr", {
5347
5424
  parentName: "thead"
@@ -5455,7 +5532,7 @@ function MDXContent(_ref) {
5455
5532
  "align": null
5456
5533
  }, (0, _react2.mdx)("inlineCode", {
5457
5534
  parentName: "td"
5458
- }, "--scope <scope>")), (0, _react2.mdx)("td", {
5535
+ }, "--scope <scope-name>")), (0, _react2.mdx)("td", {
5459
5536
  parentName: "tr",
5460
5537
  "align": "center"
5461
5538
  }, (0, _react2.mdx)("inlineCode", {
@@ -5463,7 +5540,7 @@ function MDXContent(_ref) {
5463
5540
  }, "-s")), (0, _react2.mdx)("td", {
5464
5541
  parentName: "tr",
5465
5542
  "align": null
5466
- }, "name of the scope to test")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "ui-build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5543
+ }, "DEPRECATED. (use the pattern instead, e.g. \"scopeName/", "*", "*", "\"). name of the scope to test")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "ui-build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5467
5544
  parentName: "p"
5468
5545
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
5469
5546
  parentName: "p"
@@ -5634,9 +5711,9 @@ function MDXContent(_ref) {
5634
5711
  parentName: "p"
5635
5712
  }), "\n", (0, _react2.mdx)("strong", {
5636
5713
  parentName: "p"
5637
- }, "Description"), ": set up aspects in the workspace/scope config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5714
+ }, "Description"), ": set aspects in the workspace/scope config to make them loadable by the workspace/scope"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5638
5715
  parentName: "p"
5639
- }, "bit use [ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5716
+ }, "bit use [component-ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5640
5717
  parentName: "p"
5641
5718
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
5642
5719
  parentName: "p"