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

package/dist/cli-reference.mdx.js

@@ -185,7 +185,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": manage applications"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": Manages apps"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit app <sub-command>")), (0, _react2.mdx)("h3", null, "app list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
@@ -193,7 +193,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "app list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": list all registered applications"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "Description"), ": list all registered apps"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1311,9 +1311,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": compile components in the development workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": compile components in the workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit compile [component...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit compile [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1489,9 +1489,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": create a new component from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": create a new component (source files and config) using a template."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit create <templateName> <componentNames...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit create <template-name> <component-names...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -2005,7 +2005,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": list all components envs"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": list all components maintained by the workspace and their corresponding envs"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit envs")), (0, _react2.mdx)("h3", null, "envs list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
@@ -2017,33 +2017,21 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "envs get <name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "envs get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": show component's env details"), (0, _react2.mdx)("h3", null, "envs set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "Description"), ": show information about a component's env"), (0, _react2.mdx)("h3", null, "envs set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "envs set <pattern> <env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "envs set <component-pattern> <env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": set an environment for component(s)", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "bit env set \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "envs unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "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", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "envs unset <pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "envs unset <component-pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": unset an environment from component(s) that was set by \"bit env set\"", (0, _react2.mdx)("br", {
+  }, "Description"), ": un-sets an env from components that were previously set by \"bit env set\" or by a component template", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "keep in mind that this doesn't remove envs that are set in the variants.", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -2065,7 +2053,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "envs replace <old-env> <new-env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "envs replace <current-env> <new-env>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "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", {
     parentName: "p"
@@ -2079,7 +2067,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": Export components to a remote scope", (0, _react2.mdx)("br", {
+  }, "Description"), ": export components from the workspace to remote scopes", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\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", {
     parentName: "p"
@@ -2092,7 +2080,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\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", {
     parentName: "p"
-  }, "bit export [remote] [id...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit export [remote] [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -2128,7 +2116,7 @@ function MDXContent(_ref) {
   }, "-e")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "replaces the exported components from the local scope with the corresponding packages")), (0, _react2.mdx)("tr", {
+  }, "replace the exported components with their corresponding packages (to use these components without further maintaining them)")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2143,7 +2131,7 @@ function MDXContent(_ref) {
   }, "-a")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "export all components include non-staged")), (0, _react2.mdx)("tr", {
+  }, "export all components, including non-staged")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2276,13 +2264,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": EXPERIMENTAL. create a new component out of an existing one", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "note that ", "[target-name]", " is the name only without the scope.", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "to set the default-scope, please use --scope flag"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "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", {
     parentName: "p"
-  }, "bit fork <source-id> [target-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit fork <source-component-id> [target-component-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -2318,7 +2302,7 @@ function MDXContent(_ref) {
   }, "-s")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "default scope for the newly created component")), (0, _react2.mdx)("tr", {
+  }, "default scope for the new component")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2333,7 +2317,7 @@ function MDXContent(_ref) {
   }, "-p")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "relative path in the workspace. by default the path is ", (0, _react2.mdx)("inlineCode", {
+  }, "relative path in the workspace for the new component. by default the path is ", (0, _react2.mdx)("inlineCode", {
     parentName: "td"
   }, "<scope>/<namespace>/<name>"))), (0, _react2.mdx)("tr", {
     parentName: "tbody"
@@ -2350,7 +2334,7 @@ function MDXContent(_ref) {
   }, "-r")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "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", {
+  }, "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", {
     parentName: "p"
   }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -2571,7 +2555,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": import components into your workspace", (0, _react2.mdx)("br", {
+  }, "Description"), ": import components from remote scopes to the local workspace", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
@@ -2580,7 +2564,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\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", {
     parentName: "p"
-  }, "bit import [ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit import [component-ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -2616,7 +2600,7 @@ function MDXContent(_ref) {
   }, "-p")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "import components into a specific directory")), (0, _react2.mdx)("tr", {
+  }, "import components into a specific directory (a relative path in the workspace)")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2631,7 +2615,7 @@ function MDXContent(_ref) {
   }, "-o")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "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", {
+  }, "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", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2676,7 +2660,7 @@ function MDXContent(_ref) {
   }, "-v")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "showing verbose output for inspection")), (0, _react2.mdx)("tr", {
+  }, "show verbose output for inspection")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2704,7 +2688,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "write the configuration file (component.json) of the component (harmony components only)")), (0, _react2.mdx)("tr", {
+  }, "write the configuration file (component.json) of the component")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -3002,7 +2986,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": install development workspace dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": installs workspace dependencies", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\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", {
     parentName: "p"
   }, "bit install [packages...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -3519,7 +3505,22 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "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", {
+  }, "EXPERIMENTAL. show parents and lanes data")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--json")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-j")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "login"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Workspace only"), ": no", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -3835,9 +3836,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": Create a new workspace from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": create a new workspace from a template"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit new <templateName> <workspaceName>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit new <template-name> <workspace-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -3865,7 +3866,7 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--aspect <string>")), (0, _react2.mdx)("td", {
+  }, "--aspect <aspect-id>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
@@ -3880,7 +3881,7 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--default-scope <string>")), (0, _react2.mdx)("td", {
+  }, "--default-scope <scope-name>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
@@ -3938,7 +3939,7 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--load-from <string>")), (0, _react2.mdx)("td", {
+  }, "--load-from <path-to-template>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }), (0, _react2.mdx)("td", {
@@ -4473,9 +4474,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": run an application"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": run an app (independent of bit's dev server)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit run <app>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit run <app-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -4601,19 +4602,17 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": EXPERIMENTAL. manage scope-name"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": EXPERIMENTAL. manage the scope-name for components"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit scope <sub-command>")), (0, _react2.mdx)("h3", null, "scope set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "scope set <scope-name> [pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
-    parentName: "p"
-  }, "Description"), ": set the default-scope", (0, _react2.mdx)("br", {
+  }, "scope set <scope-name> [component-pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }), "\n", "set a new scope in the workspace.jsonc.", (0, _react2.mdx)("br", {
+  }, "Description"), ": Sets components with a default-scope. If no component is specified, sets the workspace with a default scope", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\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", {
+  }), "\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", {
     parentName: "p"
   }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -4627,9 +4626,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "scope rename <old-name> <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "scope rename <current-scope-name> <new-scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "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", {
+  }, "Description"), ": Renames the scope name for all components with the specified 'current scope name'"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -4709,9 +4708,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": show a component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": display the component's essential information"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit show <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit show <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -4747,7 +4746,7 @@ function MDXContent(_ref) {
   }, "-j")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "return the component data in json format")), (0, _react2.mdx)("tr", {
+  }, "return the component data in a json format")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -4792,7 +4791,7 @@ function MDXContent(_ref) {
   }, "-c")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "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", {
+  }, "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", {
     parentName: "p"
   }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -4804,7 +4803,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": Start a dev environment for a workspace or a specific component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": run the ui/development server"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit start [type] [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -4849,7 +4848,7 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--port [number]")), (0, _react2.mdx)("td", {
+  }, "--port [port-number]")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
@@ -4887,7 +4886,7 @@ function MDXContent(_ref) {
   }, "-v")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "showing verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
+  }, "show verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -4925,12 +4924,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": show the working area component(s) status", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", (0, _react2.mdx)("a", {
-    parentName: "p",
-    "href": "https://bit.dev/docs/workspace/workspace-status"
-  }, "https://bit.dev/docs/workspace/workspace-status")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "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", {
     parentName: "p"
   }, "bit status")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -4993,7 +4987,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": record component changes and lock versions", (0, _react2.mdx)("br", {
+  }, "Description"), ": create an immutable and exportable component snapshot, tagged with a release version.", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "if no ids are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -5009,7 +5003,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\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", {
     parentName: "p"
-  }, "bit tag [id...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit tag [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -5045,7 +5039,7 @@ function MDXContent(_ref) {
   }, "-m")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "log message describing the user changes")), (0, _react2.mdx)("tr", {
+  }, "a log message describing latest changes")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5071,7 +5065,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim")), (0, _react2.mdx)("tr", {
+  }, "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim).")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5093,6 +5087,34 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
+  }, "--increment <level>")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-l")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "options are: ", "[major, premajor, minor, preminor, patch, prepatch, prerelease]", ", default to patch")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--prerelease-id <id>")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
   }, "--patch")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -5101,7 +5123,7 @@ function MDXContent(_ref) {
   }, "-p")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "increment the patch version number")), (0, _react2.mdx)("tr", {
+  }, "syntactic sugar for \"--increment patch\"")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5114,7 +5136,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "increment the minor version number")), (0, _react2.mdx)("tr", {
+  }, "syntactic sugar for \"--increment minor\"")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5127,7 +5149,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "increment the major version number")), (0, _react2.mdx)("tr", {
+  }, "syntactic sugar for \"--increment major\"")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5140,7 +5162,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "tag components that their head is a snap (not a tag)")), (0, _react2.mdx)("tr", {
+  }, "EXPERIMENTAL. tag components that their head is a snap (not a tag)")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5153,7 +5175,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)")), (0, _react2.mdx)("tr", {
+  }, "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -5339,9 +5361,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": test set of components in your workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": test components in the workspace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit test [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit test [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -5455,7 +5477,7 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--scope <scope>")), (0, _react2.mdx)("td", {
+  }, "--scope <scope-name>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
@@ -5634,9 +5656,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": set up aspects in the workspace/scope config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "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", {
     parentName: "p"
-  }, "bit use [ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "bit use [component-ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
     parentName: "p"