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

package/cli-reference.json

@@ -1086,17 +1086,33 @@
         "group": "development"
       },
       {
-        "name": "unset <component>",
+        "name": "unset <pattern>",
         "options": [],
-        "description": "unset an environment from component(s)",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
+        "description": "unset an environment from component(s) that was set by \"bit env set\"",
+        "extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
         "group": "development"
       },
       {
         "name": "replace <old-env> <new-env>",
         "options": [],
         "description": "replace an existing env with another env for all components using the old env",
-        "group": "development"
+        "group": "development",
+        "arguments": [
+          {
+            "name": "old-env",
+            "description": "current environment id"
+          },
+          {
+            "name": "new-env",
+            "description": "target environment id"
+          }
+        ],
+        "examples": [
+          {
+            "cmd": "replace teambit.harmony/aspect teambit.harmony/node",
+            "description": "all components using aspect env, will be replaced with node env"
+          }
+        ]
       }
     ]
   },
@@ -1830,30 +1846,40 @@
         "ver <version>",
         "tag with the given version"
       ],
+      [
+        "l",
+        "increment <level>",
+        "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
+      ],
+      [
+        "",
+        "prerelease-id <id>",
+        "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
+      ],
       [
         "p",
         "patch",
-        "increment the patch version number"
+        "syntactic sugar for \"--increment patch\""
       ],
       [
         "",
         "minor",
-        "increment the minor version number"
+        "syntactic sugar for \"--increment minor\""
       ],
       [
         "",
         "major",
-        "increment the major version number"
+        "syntactic sugar for \"--increment major\""
       ],
       [
         "",
         "snapped",
-        "tag components that their head is a snap (not a tag)"
+        "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
       ],
       [
         "",
         "pre-release [identifier]",
-        "EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)"
+        "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
       ],
       [
         "",
@@ -1930,7 +1956,13 @@
     "extendedDescription": "if no ids are provided, it will tag all new and modified components.\nif component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags\nyou can use a pattern for multiple ids, such as bit tag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "development",
     "private": false,
-    "remoteOp": true
+    "remoteOp": true,
+    "examples": [
+      {
+        "cmd": "tag --ver 1.0.0",
+        "description": "tag all components to version 1.0.0"
+      }
+    ]
   },
   {
     "name": "snap [id]",
@@ -1987,8 +2019,8 @@
         "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
       ]
     ],
-    "description": "record component changes.\nhttps://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
-    "extendedDescription": "",
+    "description": "EXPERIMENTAL. record component changes",
+    "extendedDescription": "https://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "ungrouped",
     "private": true
   },
@@ -2340,6 +2372,11 @@
         "",
         "parents",
         "EXPERIMENTAL. show parents and lanes data"
+      ],
+      [
+        "j",
+        "json",
+        "json format"
       ]
     ],
     "description": "show components(s) version history",
@@ -2347,7 +2384,13 @@
     "group": "info",
     "private": false,
     "remoteOp": true,
-    "skipWorkspace": true
+    "skipWorkspace": true,
+    "arguments": [
+      {
+        "name": "id",
+        "description": "component-id or component-name"
+      }
+    ]
   },
   {
     "name": "deprecate <id>",
@@ -2630,6 +2673,11 @@
             "",
             "keep-readme",
             "skip deleting the lane readme component after merging"
+          ],
+          [
+            "",
+            "squash",
+            "squash multiple snaps. keep the last one only"
           ]
         ],
         "description": "merge a local or a remote lane",

package/cli-reference.mdx

@@ -512,9 +512,12 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 ### envs unset
 
-**Usage**: `envs unset <component>`
+**Usage**: `envs unset <pattern>`
 
-**Description**: unset an environment from component(s)  
+**Description**: unset an environment from component(s) that was set by "bit env set"  
+keep in mind that this doesn't remove envs that are set in the variants.  
+in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".  
+the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.  
 you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
 always wrap the pattern with quotes to avoid collision with shell commands.  
 to validate the pattern before running this command, run `bit pattern <pattern>`.
@@ -766,6 +769,7 @@ https://bit.dev/docs/reference/cli-reference#log
 | ----------- | :--------------: | ----------------------------------------- |
 | `--remote`  |       `-r`       | show log of a remote component            |
 | `--parents` |                  | EXPERIMENTAL. show parents and lanes data |
+| `--json`    |       `-j`       | json format                               |
 
 ---
 
@@ -1144,11 +1148,13 @@ you can use a pattern for multiple ids, such as bit tag "utils/\*". (wrap the pa
 | `--unmodified`               |                  | include unmodified components (by default, only new and modified components are tagged)                                 |
 | `--editor [editor]`          |                  | EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim |
 | `--ver <version>`            |       `-v`       | tag with the given version                                                                                              |
-| `--patch`                    |       `-p`       | increment the patch version number                                                                                      |
-| `--minor`                    |                  | increment the minor version number                                                                                      |
-| `--major`                    |                  | increment the major version number                                                                                      |
-| `--snapped`                  |                  | tag components that their head is a snap (not a tag)                                                                    |
-| `--pre-release [identifier]` |                  | EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)                                                        |
+| `--increment <level>`        |       `-l`       | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch                          |
+| `--prerelease-id <id>`       |                  | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1")                                                                 |
+| `--patch`                    |       `-p`       | syntactic sugar for "--increment patch"                                                                                 |
+| `--minor`                    |                  | syntactic sugar for "--increment minor"                                                                                 |
+| `--major`                    |                  | syntactic sugar for "--increment major"                                                                                 |
+| `--snapped`                  |                  | EXPERIMENTAL. tag components that their head is a snap (not a tag)                                                      |
+| `--pre-release [identifier]` |                  | DEPRECATED. use "-l prerelease" (and --prerelease-id) instead                                                           |
 | `--skip-tests`               |                  | skip running component tests during tag process                                                                         |
 | `--skip-auto-tag`            |                  | skip auto tagging dependents                                                                                            |
 | `--soft`                     |                  | do not persist. only keep note of the changes to be made                                                                |

package/dist/cli-reference.json

@@ -1086,17 +1086,33 @@
                 "group": "development"
             },
             {
-                "name": "unset <component>",
+                "name": "unset <pattern>",
                 "options": [],
-                "description": "unset an environment from component(s)",
-                "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
+                "description": "unset an environment from component(s) that was set by \"bit env set\"",
+                "extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
                 "group": "development"
             },
             {
                 "name": "replace <old-env> <new-env>",
                 "options": [],
                 "description": "replace an existing env with another env for all components using the old env",
-                "group": "development"
+                "group": "development",
+                "arguments": [
+                    {
+                        "name": "old-env",
+                        "description": "current environment id"
+                    },
+                    {
+                        "name": "new-env",
+                        "description": "target environment id"
+                    }
+                ],
+                "examples": [
+                    {
+                        "cmd": "replace teambit.harmony/aspect teambit.harmony/node",
+                        "description": "all components using aspect env, will be replaced with node env"
+                    }
+                ]
             }
         ]
     },
@@ -1830,30 +1846,40 @@
                 "ver <version>",
                 "tag with the given version"
             ],
+            [
+                "l",
+                "increment <level>",
+                "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
+            ],
+            [
+                "",
+                "prerelease-id <id>",
+                "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
+            ],
             [
                 "p",
                 "patch",
-                "increment the patch version number"
+                "syntactic sugar for \"--increment patch\""
             ],
             [
                 "",
                 "minor",
-                "increment the minor version number"
+                "syntactic sugar for \"--increment minor\""
             ],
             [
                 "",
                 "major",
-                "increment the major version number"
+                "syntactic sugar for \"--increment major\""
             ],
             [
                 "",
                 "snapped",
-                "tag components that their head is a snap (not a tag)"
+                "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
             ],
             [
                 "",
                 "pre-release [identifier]",
-                "EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)"
+                "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
             ],
             [
                 "",
@@ -1930,7 +1956,13 @@
         "extendedDescription": "if no ids are provided, it will tag all new and modified components.\nif component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags\nyou can use a pattern for multiple ids, such as bit tag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
         "group": "development",
         "private": false,
-        "remoteOp": true
+        "remoteOp": true,
+        "examples": [
+            {
+                "cmd": "tag --ver 1.0.0",
+                "description": "tag all components to version 1.0.0"
+            }
+        ]
     },
     {
         "name": "snap [id]",
@@ -1987,8 +2019,8 @@
                 "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
             ]
         ],
-        "description": "record component changes.\nhttps://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
-        "extendedDescription": "",
+        "description": "EXPERIMENTAL. record component changes",
+        "extendedDescription": "https://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
         "group": "ungrouped",
         "private": true
     },
@@ -2340,6 +2372,11 @@
                 "",
                 "parents",
                 "EXPERIMENTAL. show parents and lanes data"
+            ],
+            [
+                "j",
+                "json",
+                "json format"
             ]
         ],
         "description": "show components(s) version history",
@@ -2347,7 +2384,13 @@
         "group": "info",
         "private": false,
         "remoteOp": true,
-        "skipWorkspace": true
+        "skipWorkspace": true,
+        "arguments": [
+            {
+                "name": "id",
+                "description": "component-id or component-name"
+            }
+        ]
     },
     {
         "name": "deprecate <id>",
@@ -2630,6 +2673,11 @@
                         "",
                         "keep-readme",
                         "skip deleting the lane readme component after merging"
+                    ],
+                    [
+                        "",
+                        "squash",
+                        "squash multiple snaps. keep the last one only"
                     ]
                 ],
                 "description": "merge a local or a remote lane",

package/dist/cli-reference.mdx.js

@@ -2041,9 +2041,15 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "envs unset <component>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "envs unset <pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": unset an environment from component(s)", (0, _react2.mdx)("br", {
+  }, "Description"), ": unset an environment from component(s) that was set by \"bit env set\"", (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"
+  }), "\n", "in only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -3513,7 +3519,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"
@@ -5087,6 +5108,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"
@@ -5095,7 +5144,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",
@@ -5108,7 +5157,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",
@@ -5121,7 +5170,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",
@@ -5134,7 +5183,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",
@@ -5147,7 +5196,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",