@teambit/harmony.content.cli-reference 1.95.35 → 1.95.38

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": "",
@@ -2920,7 +2977,17 @@
           [
             "",
             "squash",
-            "squash multiple snaps. keep the last one only"
+            "EXPERIMENTAL. squash multiple snaps. keep the last one only"
+          ],
+          [
+            "",
+            "pattern <component-pattern>",
+            "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
+          ],
+          [
+            "",
+            "include-deps",
+            "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
           ]
         ],
         "description": "merge a local or a remote lane",
@@ -3128,7 +3195,7 @@
     "remoteOp": true
   },
   {
-    "name": "export [remote] [component-names...]",
+    "name": "export [component-names...]",
     "alias": "e",
     "options": [
       [
@@ -3141,26 +3208,6 @@
         "all",
         "export all components, including non-staged"
       ],
-      [
-        "d",
-        "include-dependencies",
-        "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
-      ],
-      [
-        "s",
-        "set-current-scope",
-        "LEGACY ONLY. ensure the component's remote scope is set according to the target location"
-      ],
-      [
-        "r",
-        "rewire",
-        "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
-      ],
-      [
-        "f",
-        "force",
-        "force changing a component remote without asking for a confirmation"
-      ],
       [
         "",
         "all-versions",
@@ -3193,10 +3240,6 @@
     "private": false,
     "remoteOp": true,
     "arguments": [
-      {
-        "name": "remote",
-        "description": "LEGACY ONLY."
-      },
       {
         "name": "component-names...",
         "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."

package/cli-reference.mdx

@@ -519,16 +519,12 @@ bit export => export all staged components to their current scope, if checked ou
 https://bit.dev/docs/components/exporting-components  
 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)
 
-`bit export [remote] [component-names...]`
+`bit export [component-names...]`
 
 | **Option**                   | **Option alias** | **Description**                                                                                                                         |
 | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
 | `--eject`                    |       `-e`       | replace the exported components with their corresponding packages (to use these components without further maintaining them)            |
 | `--all`                      |       `-a`       | export all components, including non-staged                                                                                             |
-| `--include-dependencies`     |       `-d`       | LEGACY ONLY. include the component's dependencies as part of the export to the remote scope                                             |
-| `--set-current-scope`        |       `-s`       | LEGACY ONLY. ensure the component's remote scope is set according to the target location                                                |
-| `--rewire`                   |       `-r`       | LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope    |
-| `--force`                    |       `-f`       | force changing a component remote without asking for a confirmation                                                                     |
 | `--all-versions`             |                  | export not only staged versions but all of them                                                                                         |
 | `--origin-directly`          |                  | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended!                        |
 | `--resume <string>`          |                  | in case the previous export failed and suggested to resume with an export-id, enter the id                                              |
@@ -957,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`  
@@ -1217,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`  
@@ -1253,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": "",
@@ -2920,7 +2977,17 @@
                     [
                         "",
                         "squash",
-                        "squash multiple snaps. keep the last one only"
+                        "EXPERIMENTAL. squash multiple snaps. keep the last one only"
+                    ],
+                    [
+                        "",
+                        "pattern <component-pattern>",
+                        "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
+                    ],
+                    [
+                        "",
+                        "include-deps",
+                        "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
                     ]
                 ],
                 "description": "merge a local or a remote lane",
@@ -3128,7 +3195,7 @@
         "remoteOp": true
     },
     {
-        "name": "export [remote] [component-names...]",
+        "name": "export [component-names...]",
         "alias": "e",
         "options": [
             [
@@ -3141,26 +3208,6 @@
                 "all",
                 "export all components, including non-staged"
             ],
-            [
-                "d",
-                "include-dependencies",
-                "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
-            ],
-            [
-                "s",
-                "set-current-scope",
-                "LEGACY ONLY. ensure the component's remote scope is set according to the target location"
-            ],
-            [
-                "r",
-                "rewire",
-                "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
-            ],
-            [
-                "f",
-                "force",
-                "force changing a component remote without asking for a confirmation"
-            ],
             [
                 "",
                 "all-versions",
@@ -3193,10 +3240,6 @@
         "private": false,
         "remoteOp": true,
         "arguments": [
-            {
-                "name": "remote",
-                "description": "LEGACY ONLY."
-            },
             {
                 "name": "component-names...",
                 "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."