@teambit/harmony.content.cli-reference 1.95.29 → 1.95.30

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.
@@ -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"
@@ -1311,9 +1311,9 @@ function MDXContent(_ref) {
1311
1311
  parentName: "p"
1312
1312
  }), "\n", (0, _react2.mdx)("strong", {
1313
1313
  parentName: "p"
1314
- }, "Description"), ": compile components in the development workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1314
+ }, "Description"), ": compile components in the workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1315
1315
  parentName: "p"
1316
- }, "bit compile [component...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1316
+ }, "bit compile [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1317
1317
  parentName: "table"
1318
1318
  }, (0, _react2.mdx)("tr", {
1319
1319
  parentName: "thead"
@@ -1489,9 +1489,9 @@ function MDXContent(_ref) {
1489
1489
  parentName: "p"
1490
1490
  }), "\n", (0, _react2.mdx)("strong", {
1491
1491
  parentName: "p"
1492
- }, "Description"), ": create a new component from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1492
+ }, "Description"), ": create a new component (source files and config) using a template."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1493
1493
  parentName: "p"
1494
- }, "bit create <templateName> <componentNames...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1494
+ }, "bit create <template-name> <component-names...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1495
1495
  parentName: "table"
1496
1496
  }, (0, _react2.mdx)("tr", {
1497
1497
  parentName: "thead"
@@ -2005,7 +2005,7 @@ function MDXContent(_ref) {
2005
2005
  parentName: "p"
2006
2006
  }), "\n", (0, _react2.mdx)("strong", {
2007
2007
  parentName: "p"
2008
- }, "Description"), ": list all components envs"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2008
+ }, "Description"), ": list all components maintained by the workspace and their corresponding envs"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2009
2009
  parentName: "p"
2010
2010
  }, "bit envs")), (0, _react2.mdx)("h3", null, "envs list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2011
2011
  parentName: "p"
@@ -2017,33 +2017,21 @@ function MDXContent(_ref) {
2017
2017
  parentName: "p"
2018
2018
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2019
2019
  parentName: "p"
2020
- }, "envs get <name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2020
+ }, "envs get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2021
2021
  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", {
2022
+ }, "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
2023
  parentName: "p"
2024
2024
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2025
2025
  parentName: "p"
2026
- }, "envs set <pattern> <env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2026
+ }, "envs set <component-pattern> <env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2027
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", {
2033
- 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", {
2028
+ }, "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
2029
  parentName: "p"
2042
2030
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2043
2031
  parentName: "p"
2044
- }, "envs unset <pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2032
+ }, "envs unset <component-pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2045
2033
  parentName: "p"
2046
- }, "Description"), ": unset an environment from component(s) that was set by \"bit env set\"", (0, _react2.mdx)("br", {
2034
+ }, "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
2035
  parentName: "p"
2048
2036
  }), "\n", "keep in mind that this doesn't remove envs that are set in the variants.", (0, _react2.mdx)("br", {
2049
2037
  parentName: "p"
@@ -2065,7 +2053,7 @@ function MDXContent(_ref) {
2065
2053
  parentName: "p"
2066
2054
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2067
2055
  parentName: "p"
2068
- }, "envs replace <old-env> <new-env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2056
+ }, "envs replace <current-env> <new-env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2069
2057
  parentName: "p"
2070
2058
  }, "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
2059
  parentName: "p"
@@ -2079,7 +2067,7 @@ function MDXContent(_ref) {
2079
2067
  parentName: "p"
2080
2068
  }), "\n", (0, _react2.mdx)("strong", {
2081
2069
  parentName: "p"
2082
- }, "Description"), ": Export components to a remote scope", (0, _react2.mdx)("br", {
2070
+ }, "Description"), ": export components from the workspace to remote scopes", (0, _react2.mdx)("br", {
2083
2071
  parentName: "p"
2084
2072
  }), "\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
2073
  parentName: "p"
@@ -2092,7 +2080,7 @@ function MDXContent(_ref) {
2092
2080
  parentName: "p"
2093
2081
  }), "\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
2082
  parentName: "p"
2095
- }, "bit export [remote] [id...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2083
+ }, "bit export [remote] [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2096
2084
  parentName: "table"
2097
2085
  }, (0, _react2.mdx)("tr", {
2098
2086
  parentName: "thead"
@@ -2128,7 +2116,7 @@ function MDXContent(_ref) {
2128
2116
  }, "-e")), (0, _react2.mdx)("td", {
2129
2117
  parentName: "tr",
2130
2118
  "align": null
2131
- }, "replaces the exported components from the local scope with the corresponding packages")), (0, _react2.mdx)("tr", {
2119
+ }, "replace the exported components with their corresponding packages (to use these components without further maintaining them)")), (0, _react2.mdx)("tr", {
2132
2120
  parentName: "tbody"
2133
2121
  }, (0, _react2.mdx)("td", {
2134
2122
  parentName: "tr",
@@ -2143,7 +2131,7 @@ function MDXContent(_ref) {
2143
2131
  }, "-a")), (0, _react2.mdx)("td", {
2144
2132
  parentName: "tr",
2145
2133
  "align": null
2146
- }, "export all components include non-staged")), (0, _react2.mdx)("tr", {
2134
+ }, "export all components, including non-staged")), (0, _react2.mdx)("tr", {
2147
2135
  parentName: "tbody"
2148
2136
  }, (0, _react2.mdx)("td", {
2149
2137
  parentName: "tr",
@@ -2276,13 +2264,9 @@ function MDXContent(_ref) {
2276
2264
  parentName: "p"
2277
2265
  }), "\n", (0, _react2.mdx)("strong", {
2278
2266
  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", {
2267
+ }, "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
2268
  parentName: "p"
2285
- }, "bit fork <source-id> [target-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2269
+ }, "bit fork <source-component-id> [target-component-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2286
2270
  parentName: "table"
2287
2271
  }, (0, _react2.mdx)("tr", {
2288
2272
  parentName: "thead"
@@ -2318,7 +2302,7 @@ function MDXContent(_ref) {
2318
2302
  }, "-s")), (0, _react2.mdx)("td", {
2319
2303
  parentName: "tr",
2320
2304
  "align": null
2321
- }, "default scope for the newly created component")), (0, _react2.mdx)("tr", {
2305
+ }, "default scope for the new component")), (0, _react2.mdx)("tr", {
2322
2306
  parentName: "tbody"
2323
2307
  }, (0, _react2.mdx)("td", {
2324
2308
  parentName: "tr",
@@ -2333,7 +2317,7 @@ function MDXContent(_ref) {
2333
2317
  }, "-p")), (0, _react2.mdx)("td", {
2334
2318
  parentName: "tr",
2335
2319
  "align": null
2336
- }, "relative path in the workspace. by default the path is ", (0, _react2.mdx)("inlineCode", {
2320
+ }, "relative path in the workspace for the new component. by default the path is ", (0, _react2.mdx)("inlineCode", {
2337
2321
  parentName: "td"
2338
2322
  }, "<scope>/<namespace>/<name>"))), (0, _react2.mdx)("tr", {
2339
2323
  parentName: "tbody"
@@ -2350,7 +2334,7 @@ function MDXContent(_ref) {
2350
2334
  }, "-r")), (0, _react2.mdx)("td", {
2351
2335
  parentName: "tr",
2352
2336
  "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", {
2337
+ }, "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
2338
  parentName: "p"
2355
2339
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
2356
2340
  parentName: "p"
@@ -2571,7 +2555,7 @@ function MDXContent(_ref) {
2571
2555
  parentName: "p"
2572
2556
  }), "\n", (0, _react2.mdx)("strong", {
2573
2557
  parentName: "p"
2574
- }, "Description"), ": import components into your workspace", (0, _react2.mdx)("br", {
2558
+ }, "Description"), ": import components from remote scopes to the local workspace", (0, _react2.mdx)("br", {
2575
2559
  parentName: "p"
2576
2560
  }), "\n", (0, _react2.mdx)("a", {
2577
2561
  parentName: "p",
@@ -2580,7 +2564,7 @@ function MDXContent(_ref) {
2580
2564
  parentName: "p"
2581
2565
  }), "\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
2566
  parentName: "p"
2583
- }, "bit import [ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2567
+ }, "bit import [component-ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2584
2568
  parentName: "table"
2585
2569
  }, (0, _react2.mdx)("tr", {
2586
2570
  parentName: "thead"
@@ -2616,7 +2600,7 @@ function MDXContent(_ref) {
2616
2600
  }, "-p")), (0, _react2.mdx)("td", {
2617
2601
  parentName: "tr",
2618
2602
  "align": null
2619
- }, "import components into a specific directory")), (0, _react2.mdx)("tr", {
2603
+ }, "import components into a specific directory (a relative path in the workspace)")), (0, _react2.mdx)("tr", {
2620
2604
  parentName: "tbody"
2621
2605
  }, (0, _react2.mdx)("td", {
2622
2606
  parentName: "tr",
@@ -2631,7 +2615,7 @@ function MDXContent(_ref) {
2631
2615
  }, "-o")), (0, _react2.mdx)("td", {
2632
2616
  parentName: "tr",
2633
2617
  "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", {
2618
+ }, "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
2619
  parentName: "tbody"
2636
2620
  }, (0, _react2.mdx)("td", {
2637
2621
  parentName: "tr",
@@ -2676,7 +2660,7 @@ function MDXContent(_ref) {
2676
2660
  }, "-v")), (0, _react2.mdx)("td", {
2677
2661
  parentName: "tr",
2678
2662
  "align": null
2679
- }, "showing verbose output for inspection")), (0, _react2.mdx)("tr", {
2663
+ }, "show verbose output for inspection")), (0, _react2.mdx)("tr", {
2680
2664
  parentName: "tbody"
2681
2665
  }, (0, _react2.mdx)("td", {
2682
2666
  parentName: "tr",
@@ -2704,7 +2688,7 @@ function MDXContent(_ref) {
2704
2688
  }), (0, _react2.mdx)("td", {
2705
2689
  parentName: "tr",
2706
2690
  "align": null
2707
- }, "write the configuration file (component.json) of the component (harmony components only)")), (0, _react2.mdx)("tr", {
2691
+ }, "write the configuration file (component.json) of the component")), (0, _react2.mdx)("tr", {
2708
2692
  parentName: "tbody"
2709
2693
  }, (0, _react2.mdx)("td", {
2710
2694
  parentName: "tr",
@@ -3002,7 +2986,9 @@ function MDXContent(_ref) {
3002
2986
  parentName: "p"
3003
2987
  }), "\n", (0, _react2.mdx)("strong", {
3004
2988
  parentName: "p"
3005
- }, "Description"), ": install development workspace dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2989
+ }, "Description"), ": installs workspace dependencies", (0, _react2.mdx)("br", {
2990
+ parentName: "p"
2991
+ }), "\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
2992
  parentName: "p"
3007
2993
  }, "bit install [packages...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
3008
2994
  parentName: "table"
@@ -3850,9 +3836,9 @@ function MDXContent(_ref) {
3850
3836
  parentName: "p"
3851
3837
  }), "\n", (0, _react2.mdx)("strong", {
3852
3838
  parentName: "p"
3853
- }, "Description"), ": Create a new workspace from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
3839
+ }, "Description"), ": create a new workspace from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
3854
3840
  parentName: "p"
3855
- }, "bit new <templateName> <workspaceName>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
3841
+ }, "bit new <template-name> <workspace-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
3856
3842
  parentName: "table"
3857
3843
  }, (0, _react2.mdx)("tr", {
3858
3844
  parentName: "thead"
@@ -3880,7 +3866,7 @@ function MDXContent(_ref) {
3880
3866
  "align": null
3881
3867
  }, (0, _react2.mdx)("inlineCode", {
3882
3868
  parentName: "td"
3883
- }, "--aspect <string>")), (0, _react2.mdx)("td", {
3869
+ }, "--aspect <aspect-id>")), (0, _react2.mdx)("td", {
3884
3870
  parentName: "tr",
3885
3871
  "align": "center"
3886
3872
  }, (0, _react2.mdx)("inlineCode", {
@@ -3895,7 +3881,7 @@ function MDXContent(_ref) {
3895
3881
  "align": null
3896
3882
  }, (0, _react2.mdx)("inlineCode", {
3897
3883
  parentName: "td"
3898
- }, "--default-scope <string>")), (0, _react2.mdx)("td", {
3884
+ }, "--default-scope <scope-name>")), (0, _react2.mdx)("td", {
3899
3885
  parentName: "tr",
3900
3886
  "align": "center"
3901
3887
  }, (0, _react2.mdx)("inlineCode", {
@@ -3953,7 +3939,7 @@ function MDXContent(_ref) {
3953
3939
  "align": null
3954
3940
  }, (0, _react2.mdx)("inlineCode", {
3955
3941
  parentName: "td"
3956
- }, "--load-from <string>")), (0, _react2.mdx)("td", {
3942
+ }, "--load-from <path-to-template>")), (0, _react2.mdx)("td", {
3957
3943
  parentName: "tr",
3958
3944
  "align": "center"
3959
3945
  }), (0, _react2.mdx)("td", {
@@ -4488,9 +4474,9 @@ function MDXContent(_ref) {
4488
4474
  parentName: "p"
4489
4475
  }), "\n", (0, _react2.mdx)("strong", {
4490
4476
  parentName: "p"
4491
- }, "Description"), ": run an application"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4477
+ }, "Description"), ": run an app (independent of bit's dev server)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4492
4478
  parentName: "p"
4493
- }, "bit run <app>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4479
+ }, "bit run <app-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4494
4480
  parentName: "table"
4495
4481
  }, (0, _react2.mdx)("tr", {
4496
4482
  parentName: "thead"
@@ -4616,19 +4602,17 @@ function MDXContent(_ref) {
4616
4602
  parentName: "p"
4617
4603
  }), "\n", (0, _react2.mdx)("strong", {
4618
4604
  parentName: "p"
4619
- }, "Description"), ": EXPERIMENTAL. manage scope-name"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4605
+ }, "Description"), ": EXPERIMENTAL. manage the scope-name for components"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4620
4606
  parentName: "p"
4621
4607
  }, "bit scope <sub-command>")), (0, _react2.mdx)("h3", null, "scope set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4622
4608
  parentName: "p"
4623
4609
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4624
4610
  parentName: "p"
4625
- }, "scope set <scope-name> [pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4611
+ }, "scope set <scope-name> [component-pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4626
4612
  parentName: "p"
4627
- }, "Description"), ": set the default-scope", (0, _react2.mdx)("br", {
4613
+ }, "Description"), ": Sets components with a default-scope. If no component is specified, sets the workspace with a default scope", (0, _react2.mdx)("br", {
4628
4614
  parentName: "p"
4629
- }), "\n", "set a new scope in the workspace.jsonc.", (0, _react2.mdx)("br", {
4630
- parentName: "p"
4631
- }), "\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", {
4615
+ }), "\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", {
4632
4616
  parentName: "p"
4633
4617
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4634
4618
  parentName: "p"
@@ -4642,9 +4626,9 @@ function MDXContent(_ref) {
4642
4626
  parentName: "p"
4643
4627
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4644
4628
  parentName: "p"
4645
- }, "scope rename <old-name> <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4629
+ }, "scope rename <current-scope-name> <new-scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4646
4630
  parentName: "p"
4647
- }, "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", {
4631
+ }, "Description"), ": Renames the scope name for all components with the specified 'current scope name'"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4648
4632
  parentName: "table"
4649
4633
  }, (0, _react2.mdx)("tr", {
4650
4634
  parentName: "thead"
@@ -4724,9 +4708,9 @@ function MDXContent(_ref) {
4724
4708
  parentName: "p"
4725
4709
  }), "\n", (0, _react2.mdx)("strong", {
4726
4710
  parentName: "p"
4727
- }, "Description"), ": show a component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4711
+ }, "Description"), ": display the component's essential information"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4728
4712
  parentName: "p"
4729
- }, "bit show <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4713
+ }, "bit show <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4730
4714
  parentName: "table"
4731
4715
  }, (0, _react2.mdx)("tr", {
4732
4716
  parentName: "thead"
@@ -4762,7 +4746,7 @@ function MDXContent(_ref) {
4762
4746
  }, "-j")), (0, _react2.mdx)("td", {
4763
4747
  parentName: "tr",
4764
4748
  "align": null
4765
- }, "return the component data in json format")), (0, _react2.mdx)("tr", {
4749
+ }, "return the component data in a json format")), (0, _react2.mdx)("tr", {
4766
4750
  parentName: "tbody"
4767
4751
  }, (0, _react2.mdx)("td", {
4768
4752
  parentName: "tr",
@@ -4807,7 +4791,7 @@ function MDXContent(_ref) {
4807
4791
  }, "-c")), (0, _react2.mdx)("td", {
4808
4792
  parentName: "tr",
4809
4793
  "align": null
4810
- }, "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", {
4794
+ }, "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", {
4811
4795
  parentName: "p"
4812
4796
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
4813
4797
  parentName: "p"
@@ -4819,7 +4803,7 @@ function MDXContent(_ref) {
4819
4803
  parentName: "p"
4820
4804
  }), "\n", (0, _react2.mdx)("strong", {
4821
4805
  parentName: "p"
4822
- }, "Description"), ": Start a dev environment for a workspace or a specific component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4806
+ }, "Description"), ": run the ui/development server"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4823
4807
  parentName: "p"
4824
4808
  }, "bit start [type] [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4825
4809
  parentName: "table"
@@ -4864,7 +4848,7 @@ function MDXContent(_ref) {
4864
4848
  "align": null
4865
4849
  }, (0, _react2.mdx)("inlineCode", {
4866
4850
  parentName: "td"
4867
- }, "--port [number]")), (0, _react2.mdx)("td", {
4851
+ }, "--port [port-number]")), (0, _react2.mdx)("td", {
4868
4852
  parentName: "tr",
4869
4853
  "align": "center"
4870
4854
  }, (0, _react2.mdx)("inlineCode", {
@@ -4902,7 +4886,7 @@ function MDXContent(_ref) {
4902
4886
  }, "-v")), (0, _react2.mdx)("td", {
4903
4887
  parentName: "tr",
4904
4888
  "align": null
4905
- }, "showing verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
4889
+ }, "show verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
4906
4890
  parentName: "tbody"
4907
4891
  }, (0, _react2.mdx)("td", {
4908
4892
  parentName: "tr",
@@ -4940,12 +4924,7 @@ function MDXContent(_ref) {
4940
4924
  parentName: "p"
4941
4925
  }), "\n", (0, _react2.mdx)("strong", {
4942
4926
  parentName: "p"
4943
- }, "Description"), ": show the working area component(s) status", (0, _react2.mdx)("br", {
4944
- parentName: "p"
4945
- }), "\n", (0, _react2.mdx)("a", {
4946
- parentName: "p",
4947
- "href": "https://bit.dev/docs/workspace/workspace-status"
4948
- }, "https://bit.dev/docs/workspace/workspace-status")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4927
+ }, "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", {
4949
4928
  parentName: "p"
4950
4929
  }, "bit status")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4951
4930
  parentName: "table"
@@ -5008,7 +4987,7 @@ function MDXContent(_ref) {
5008
4987
  parentName: "p"
5009
4988
  }), "\n", (0, _react2.mdx)("strong", {
5010
4989
  parentName: "p"
5011
- }, "Description"), ": record component changes and lock versions", (0, _react2.mdx)("br", {
4990
+ }, "Description"), ": create an immutable and exportable component snapshot, tagged with a release version.", (0, _react2.mdx)("br", {
5012
4991
  parentName: "p"
5013
4992
  }), "\n", "if no ids are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
5014
4993
  parentName: "p"
@@ -5024,7 +5003,7 @@ function MDXContent(_ref) {
5024
5003
  parentName: "p"
5025
5004
  }), "\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", {
5026
5005
  parentName: "p"
5027
- }, "bit tag [id...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5006
+ }, "bit tag [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5028
5007
  parentName: "table"
5029
5008
  }, (0, _react2.mdx)("tr", {
5030
5009
  parentName: "thead"
@@ -5060,7 +5039,7 @@ function MDXContent(_ref) {
5060
5039
  }, "-m")), (0, _react2.mdx)("td", {
5061
5040
  parentName: "tr",
5062
5041
  "align": null
5063
- }, "log message describing the user changes")), (0, _react2.mdx)("tr", {
5042
+ }, "a log message describing latest changes")), (0, _react2.mdx)("tr", {
5064
5043
  parentName: "tbody"
5065
5044
  }, (0, _react2.mdx)("td", {
5066
5045
  parentName: "tr",
@@ -5086,7 +5065,7 @@ function MDXContent(_ref) {
5086
5065
  }), (0, _react2.mdx)("td", {
5087
5066
  parentName: "tr",
5088
5067
  "align": null
5089
- }, "EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim")), (0, _react2.mdx)("tr", {
5068
+ }, "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim).")), (0, _react2.mdx)("tr", {
5090
5069
  parentName: "tbody"
5091
5070
  }, (0, _react2.mdx)("td", {
5092
5071
  parentName: "tr",
@@ -5382,9 +5361,9 @@ function MDXContent(_ref) {
5382
5361
  parentName: "p"
5383
5362
  }), "\n", (0, _react2.mdx)("strong", {
5384
5363
  parentName: "p"
5385
- }, "Description"), ": test set of components in your workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5364
+ }, "Description"), ": test components in the workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5386
5365
  parentName: "p"
5387
- }, "bit test [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5366
+ }, "bit test [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5388
5367
  parentName: "table"
5389
5368
  }, (0, _react2.mdx)("tr", {
5390
5369
  parentName: "thead"
@@ -5498,7 +5477,7 @@ function MDXContent(_ref) {
5498
5477
  "align": null
5499
5478
  }, (0, _react2.mdx)("inlineCode", {
5500
5479
  parentName: "td"
5501
- }, "--scope <scope>")), (0, _react2.mdx)("td", {
5480
+ }, "--scope <scope-name>")), (0, _react2.mdx)("td", {
5502
5481
  parentName: "tr",
5503
5482
  "align": "center"
5504
5483
  }, (0, _react2.mdx)("inlineCode", {
@@ -5677,9 +5656,9 @@ function MDXContent(_ref) {
5677
5656
  parentName: "p"
5678
5657
  }), "\n", (0, _react2.mdx)("strong", {
5679
5658
  parentName: "p"
5680
- }, "Description"), ": set up aspects in the workspace/scope config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5659
+ }, "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", {
5681
5660
  parentName: "p"
5682
- }, "bit use [ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5661
+ }, "bit use [component-ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5683
5662
  parentName: "p"
5684
5663
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
5685
5664
  parentName: "p"