@teambit/harmony.content.cli-reference 1.95.36 → 1.95.37

package/cli-reference.json

@@ -543,7 +543,7 @@
     "description": "revert tagged or snapped versions for component(s)",
     "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "development",
-    "private": false
+    "private": true
   },
   {
     "name": "move <current-component-dir> <new-component-dir>",
@@ -955,22 +955,6 @@
     "group": "general",
     "private": false
   },
-  {
-    "name": "use [component-ids...]",
-    "alias": "",
-    "options": [],
-    "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
-    "extendedDescription": "",
-    "group": "collaborate",
-    "private": false,
-    "remoteOp": true,
-    "arguments": [
-      {
-        "name": "component-ids...",
-        "description": "the component IDs of the aspects"
-      }
-    ]
-  },
   {
     "name": "show <component-name>",
     "alias": "",
@@ -1048,7 +1032,7 @@
         "arguments": [
           {
             "name": "component-pattern",
-            "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse commas to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+            "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
           },
           {
             "name": "env",
@@ -1484,6 +1468,22 @@
       }
     ]
   },
+  {
+    "name": "use <component-id>",
+    "alias": "",
+    "options": [],
+    "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
+    "extendedDescription": "",
+    "group": "collaborate",
+    "private": false,
+    "remoteOp": true,
+    "arguments": [
+      {
+        "name": "component-id",
+        "description": "the component ID of the aspect"
+      }
+    ]
+  },
   {
     "name": "pattern <pattern>",
     "alias": "",
@@ -1497,7 +1497,29 @@
     "description": "list the component ids matching the given pattern",
     "extendedDescription": "this command helps validating a pattern before using it in other commands.\na pattern can be a simple component-id or component-name. e.g. \"ui/button\".\na pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/**\".\nto enter multiple patterns, separate them by a comma, e.g. \"ui/*, lib/*\"\nto exclude, use \"!\". e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nthe matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)\n",
     "group": "development",
-    "private": false
+    "private": false,
+    "examples": [
+      {
+        "cmd": "bit pattern \"**\"",
+        "description": "matches all components"
+      },
+      {
+        "cmd": "bit pattern \"*/ui/*\"",
+        "description": "matches components with any scope-name and the \"ui\" namespace. e.g. \"ui/button\" but not \"ui/elements/button\""
+      },
+      {
+        "cmd": "bit pattern \"*/ui/**\"",
+        "description": "matches components that their namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
+      },
+      {
+        "cmd": "bit pattern \"bar, foo\"",
+        "description": "matches two components: bar and foo"
+      },
+      {
+        "cmd": "bit pattern \"my-scope.org/**\"",
+        "description": "matches all components of the scope \"my-scope.org\""
+      }
+    ]
   },
   {
     "name": "list [remote-scope]",
@@ -2167,6 +2189,41 @@
       }
     ]
   },
+  {
+    "name": "reset [component-pattern] [component-version]",
+    "alias": "",
+    "options": [
+      [
+        "a",
+        "all",
+        "revert tag/snap for all tagged/snapped components"
+      ],
+      [
+        "",
+        "soft",
+        "revert only soft-tags (components tagged with --soft flag)"
+      ],
+      [
+        "f",
+        "force",
+        "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
+      ]
+    ],
+    "description": "revert tagged or snapped versions for component(s)",
+    "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
+    "group": "development",
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-pattern",
+        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+      },
+      {
+        "name": "component-version",
+        "description": "the version to untag (semver for tags. hash for snaps)"
+      }
+    ]
+  },
   {
     "name": "merge [values...]",
     "alias": "",

package/cli-reference.mdx

@@ -953,6 +953,22 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
 
 ---
 
+## reset
+
+**Workspace only**: yes  
+**Description**: revert tagged or snapped versions for component(s)  
+https://bit.dev/docs/components/tags#undoing-a-tag
+
+`bit reset [component-pattern] [component-version]`
+
+| **Option** | **Option alias** | **Description**                                                                                       |
+| ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
+| `--all`    |       `-a`       | revert tag/snap for all tagged/snapped components                                                     |
+| `--soft`   |                  | revert only soft-tags (components tagged with --soft flag)                                            |
+| `--force`  |       `-f`       | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
+
+---
+
 ## run
 
 **Alias**: `c`  
@@ -1213,23 +1229,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 ---
 
-## untag
-
-**Workspace only**: yes  
-**Description**: revert tagged or snapped versions for component(s)  
-https://bit.dev/docs/components/tags#undoing-a-tag  
-you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
-
-`bit untag [component-name] [component-version]`
-
-| **Option** | **Option alias** | **Description**                                                                                       |
-| ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
-| `--all`    |       `-a`       | revert tag for all tagged components                                                                  |
-| `--soft`   |                  | harmony - revert only soft-tags (components tagged with --soft flag)                                  |
-| `--force`  |       `-f`       | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
-
----
-
 ## update
 
 **Alias**: `up`  
@@ -1249,7 +1248,7 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
 **Workspace only**: yes  
 **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
 
-`bit use [component-ids...]`
+`bit use <component-id>`
 
 ---
 

package/dist/cli-reference.json

@@ -543,7 +543,7 @@
         "description": "revert tagged or snapped versions for component(s)",
         "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
         "group": "development",
-        "private": false
+        "private": true
     },
     {
         "name": "move <current-component-dir> <new-component-dir>",
@@ -955,22 +955,6 @@
         "group": "general",
         "private": false
     },
-    {
-        "name": "use [component-ids...]",
-        "alias": "",
-        "options": [],
-        "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
-        "extendedDescription": "",
-        "group": "collaborate",
-        "private": false,
-        "remoteOp": true,
-        "arguments": [
-            {
-                "name": "component-ids...",
-                "description": "the component IDs of the aspects"
-            }
-        ]
-    },
     {
         "name": "show <component-name>",
         "alias": "",
@@ -1048,7 +1032,7 @@
                 "arguments": [
                     {
                         "name": "component-pattern",
-                        "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse commas to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+                        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
                     },
                     {
                         "name": "env",
@@ -1484,6 +1468,22 @@
             }
         ]
     },
+    {
+        "name": "use <component-id>",
+        "alias": "",
+        "options": [],
+        "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
+        "extendedDescription": "",
+        "group": "collaborate",
+        "private": false,
+        "remoteOp": true,
+        "arguments": [
+            {
+                "name": "component-id",
+                "description": "the component ID of the aspect"
+            }
+        ]
+    },
     {
         "name": "pattern <pattern>",
         "alias": "",
@@ -1497,7 +1497,29 @@
         "description": "list the component ids matching the given pattern",
         "extendedDescription": "this command helps validating a pattern before using it in other commands.\na pattern can be a simple component-id or component-name. e.g. \"ui/button\".\na pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/**\".\nto enter multiple patterns, separate them by a comma, e.g. \"ui/*, lib/*\"\nto exclude, use \"!\". e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nthe matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)\n",
         "group": "development",
-        "private": false
+        "private": false,
+        "examples": [
+            {
+                "cmd": "bit pattern \"**\"",
+                "description": "matches all components"
+            },
+            {
+                "cmd": "bit pattern \"*/ui/*\"",
+                "description": "matches components with any scope-name and the \"ui\" namespace. e.g. \"ui/button\" but not \"ui/elements/button\""
+            },
+            {
+                "cmd": "bit pattern \"*/ui/**\"",
+                "description": "matches components that their namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
+            },
+            {
+                "cmd": "bit pattern \"bar, foo\"",
+                "description": "matches two components: bar and foo"
+            },
+            {
+                "cmd": "bit pattern \"my-scope.org/**\"",
+                "description": "matches all components of the scope \"my-scope.org\""
+            }
+        ]
     },
     {
         "name": "list [remote-scope]",
@@ -2167,6 +2189,41 @@
             }
         ]
     },
+    {
+        "name": "reset [component-pattern] [component-version]",
+        "alias": "",
+        "options": [
+            [
+                "a",
+                "all",
+                "revert tag/snap for all tagged/snapped components"
+            ],
+            [
+                "",
+                "soft",
+                "revert only soft-tags (components tagged with --soft flag)"
+            ],
+            [
+                "f",
+                "force",
+                "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
+            ]
+        ],
+        "description": "revert tagged or snapped versions for component(s)",
+        "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
+        "group": "development",
+        "private": false,
+        "arguments": [
+            {
+                "name": "component-pattern",
+                "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+            },
+            {
+                "name": "component-version",
+                "description": "the version to untag (semver for tags. hash for snaps)"
+            }
+        ]
+    },
     {
         "name": "merge [values...]",
         "alias": "",

package/dist/cli-reference.mdx.js

@@ -4335,7 +4335,84 @@ function MDXContent(_ref) {
   }, "-r")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "update the import/require statements in all dependent components (in the same workspace)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "run"), (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, "reset"), (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"), ": revert tagged or snapped versions for component(s)", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\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)("p", null, (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "bit reset [component-pattern] [component-version]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+    parentName: "table"
+  }, (0, _react2.mdx)("tr", {
+    parentName: "thead"
+  }, (0, _react2.mdx)("th", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("strong", {
+    parentName: "th"
+  }, "Option")), (0, _react2.mdx)("th", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "th"
+  }, "Option alias")), (0, _react2.mdx)("th", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("strong", {
+    parentName: "th"
+  }, "Description")))), (0, _react2.mdx)("tbody", {
+    parentName: "table"
+  }, (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--all")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-a")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "revert tag/snap for all tagged/snapped components")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--soft")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "revert only soft-tags (components tagged with --soft flag)")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--force")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-f")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt")))), (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"
@@ -5402,86 +5479,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": uninstall dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit uninstall [packages...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "untag"), (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"), ": revert tagged or snapped versions for component(s)", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\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", {
-    parentName: "p"
-  }), "\n", "you can use a pattern for multiple ids, such as bit untag \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "bit untag [component-name] [component-version]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
-    parentName: "table"
-  }, (0, _react2.mdx)("tr", {
-    parentName: "thead"
-  }, (0, _react2.mdx)("th", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("strong", {
-    parentName: "th"
-  }, "Option")), (0, _react2.mdx)("th", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("strong", {
-    parentName: "th"
-  }, "Option alias")), (0, _react2.mdx)("th", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("strong", {
-    parentName: "th"
-  }, "Description")))), (0, _react2.mdx)("tbody", {
-    parentName: "table"
-  }, (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--all")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-a")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "revert tag for all tagged components")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--soft")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "harmony - revert only soft-tags (components tagged with --soft flag)")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--force")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-f")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "bit uninstall [packages...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -5539,7 +5537,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "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 [component-ids...]")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "bit use <component-id>")), (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"