@teambit/harmony.content.cli-reference 1.95.23 → 1.95.26

package/dist/cli-reference.mdx.js

@@ -32,7 +32,7 @@ function MDXContent(_ref) {
   return (0, _react2.mdx)(MDXLayout, _extends({}, layoutProps, props, {
     components: components,
     mdxType: "MDXLayout"
-  }), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("p", null, "id: cli-all"), (0, _react2.mdx)("h2", null, "title: CLI Commands"), (0, _react2.mdx)("h1", null, "CLI Reference"), (0, _react2.mdx)("p", null, "Commands that are marked as workspace only must be executed inside a workspace. Commands that are marked as not workspace only, can be executed from anywhere and will run on a remote server."), (0, _react2.mdx)("h2", null, "add"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }), (0, _react2.mdx)("h1", null, "CLI Reference"), (0, _react2.mdx)("p", null, "Commands that are marked as workspace only must be executed inside a workspace. Commands that are marked as not workspace only, can be executed from anywhere and will run on a remote server."), (0, _react2.mdx)("h2", null, "add"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -44,7 +44,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": add any subset of files to be tracked as a component(s)", (0, _react2.mdx)("br", {
+  }, "Description"), ": Add any subset of files to be tracked as a component(s).", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "all flags support glob patterns and {PARENT} {FILE_NAME} annotations", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -235,7 +235,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": EXPERIMENTAL. list and download components artifacts.", (0, _react2.mdx)("br", {
+  }, "Description"), ": EXPERIMENTAL. list and download components artifacts", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "artifacts are created on isolated capsules during tag or snap commands.", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -645,7 +645,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": manage capsules.", (0, _react2.mdx)("br", {
+  }, "Description"), ": manage capsules", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "a capsule is a directory contains the component code, isolated from the workspace.", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -850,7 +850,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "capsule delete")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": delete capsules. with no args, only workspace's capsules are deleted"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "Description"), ": delete capsules", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "with no args, only workspace's capsules are deleted"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -968,15 +970,17 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": switch between component versions or remove local changes", (0, _react2.mdx)("br", {
+  }, "Description"), ": switch between component versions or remove local changes"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "bit checkout <version> [ids...]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit checkout <version> [ids...]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
+  }, "bit checkout latest"), " => checkout all components to their latest versions", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit checkout latest [ids...]"), " => checkout the specified ids (or all components when --all is used) to their latest versions", (0, _react2.mdx)("br", {
+  }, "bit checkout latest [ids...]"), " => checkout the specified ids to their latest versions", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -1286,7 +1290,22 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "compile"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands")), (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
+  }, "output the commands info as JSON")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "compile"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -1433,9 +1452,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": global config management.", (0, _react2.mdx)("br", {
+  }, "Description"), ": global config management", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
     "href": "https://bit.dev/docs/config/bit-config"
   }, "https://bit.dev/docs/config/bit-config")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -2054,7 +2073,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 to a remote scope", (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"
@@ -2546,7 +2565,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": import components into your current workspace.", (0, _react2.mdx)("br", {
+  }, "Description"), ": import components into your workspace", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
@@ -2753,13 +2772,13 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--skip-lane")), (0, _react2.mdx)("td", {
+  }, "--save-in-lane")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "EXPERIMENTAL. when checked out to a lane, do not import the component into the lane, save it on main")), (0, _react2.mdx)("tr", {
+  }, "EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -2778,7 +2797,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": initialize an empty bit scope", (0, _react2.mdx)("br", {
+  }, "Description"), ": create or reinitialize an empty workspace", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
@@ -3103,7 +3122,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": generate symlinks to resolve module paths for imported components.", (0, _react2.mdx)("br", {
+  }, "Description"), ": link components and core aspects", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
@@ -3299,9 +3318,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": list components on a local or a remote scope.", (0, _react2.mdx)("br", {
+  }, "Description"), ": list components on a workspace, local scope or a remote scope.", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
     "href": "https://bit.dev/docs/reference/cli-reference#list"
   }, "https://bit.dev/docs/reference/cli-reference#list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -3438,9 +3457,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": show components(s) tag history.", (0, _react2.mdx)("br", {
+  }, "Description"), ": show components(s) version history", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
     "href": "https://bit.dev/docs/reference/cli-reference#log"
   }, "https://bit.dev/docs/reference/cli-reference#log")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -3606,6 +3625,8 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": merge changes of different component versions", (0, _react2.mdx)("br", {
     parentName: "p"
+  }), "\n", "merge changes of different component versions", (0, _react2.mdx)("br", {
+    parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit merge <version> [ids...]"), " => merge changes of the given version into the checked out version", (0, _react2.mdx)("br", {
@@ -3755,7 +3776,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": move files or directories of component(s)", (0, _react2.mdx)("br", {
+  }, "Description"), ": move a component to a different filesystem path", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "move files or directories of component(s)", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("a", {
     parentName: "p",
@@ -4091,7 +4114,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": manage set of tracked bit scope(s)", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
     "href": "https://bit.dev/docs/scope/remote-scopes"
   }, "https://bit.dev/docs/scope/remote-scopes")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -4102,14 +4125,11 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "remote add <url>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": add a bare-scope as a remote. supported protocols are ", "[file, http, ssh]", ".", (0, _react2.mdx)("br", {
+  }, "Description"), ": add a bare-scope as a remote", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "for example: \"http://localhost:3000\", \"file:///tmp/local-scope\", \"ssh://", (0, _react2.mdx)("a", {
-    parentName: "p",
-    "href": "mailto:user@127.0.0.1"
-  }, "user@127.0.0.1"), ":/tmp/local-scope\".", (0, _react2.mdx)("br", {
+  }), "\n", "supported protocols are ", "[file, http]", ".", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "Legacy support ", "[file, ssh]", ". Harmony supports ", "[file, http]", "."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }), "\n", "for example: \"http://localhost:3000\", \"file:///tmp/local-scope\""), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -4235,9 +4255,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": remove a component (local/remote)", (0, _react2.mdx)("br", {
+  }, "Description"), ": remove component(s) from your workspace, or a remote scope", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
     "href": "https://bit.dev/docs/components/removing-components"
   }, "https://bit.dev/docs/components/removing-components"), (0, _react2.mdx)("br", {
@@ -4435,19 +4455,7 @@ function MDXContent(_ref) {
   }, "-r")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "change the source code of all components using this component with the new package-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "resume-export"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
-    parentName: "p"
-  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", (0, _react2.mdx)("strong", {
-    parentName: "p"
-  }, "Description"), ": resume failed export to persist the pending objects on the given remotes.", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "the export-id is the id the client got in the error message during the failure.", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "alternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "bit resume-export <export-id> <remotes...>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "run"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "change the source code of all components using this component with the new package-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "run"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -4531,9 +4539,21 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": shows the API schema of a certain component."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": shows the API schema of a certain component.", (0, _react2.mdx)("br", {
     parentName: "p"
-  }, "bit schema <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }), "\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 schema \"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)("p", null, (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "bit schema <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -4899,9 +4919,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": show the working area component(s) status.", (0, _react2.mdx)("br", {
+  }, "Description"), ": show the working area component(s) status", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\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", {
@@ -4967,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"), ": record component changes and lock versions", (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"
@@ -5261,7 +5281,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": list templates for \"bit create\" and \"bit new\"", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit templates")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -5477,9 +5499,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": revert version(s) tagged for component(s)", (0, _react2.mdx)("br", {
+  }, "Description"), ": revert versions tagged for component(s)", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
+  }), "\n", (0, _react2.mdx)("a", {
     parentName: "p",
     "href": "https://bit.dev/docs/components/tags#undoing-a-tag"
   }, "https://bit.dev/docs/components/tags#undoing-a-tag"), (0, _react2.mdx)("br", {