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

package/cli-reference.json

@@ -1130,7 +1130,7 @@
         "name": "unset <component-pattern>",
         "options": [],
         "description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
-        "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",
+        "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/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "arguments": [
           {
@@ -1225,7 +1225,7 @@
         "name": "set <scope-name> [component-pattern]",
         "options": [],
         "description": "Sets components with a default-scope. If no component is specified, sets the workspace with a default scope",
-        "extendedDescription": "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.'\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"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",
+        "extendedDescription": "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.'\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "arguments": [
           {
@@ -1353,7 +1353,7 @@
       ]
     ],
     "description": "eject components configuration (create a `component.json` file)",
-    "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"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",
+    "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
     "group": "development",
     "private": false
   },
@@ -1524,7 +1524,7 @@
       ]
     ],
     "description": "list the component ids matching the given pattern",
-    "extendedDescription": "",
+    "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
   },
@@ -1734,7 +1734,7 @@
     ]
   },
   {
-    "name": "build [pattern]",
+    "name": "build [component-pattern]",
     "alias": "",
     "options": [
       [
@@ -1776,7 +1776,13 @@
     "description": "run set of tasks for build",
     "extendedDescription": "",
     "group": "development",
-    "private": false
+    "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": "artifacts <pattern...>",
@@ -1924,7 +1930,7 @@
     "private": true
   },
   {
-    "name": "tag [component-names...]",
+    "name": "tag [patterns...]",
     "alias": "t",
     "options": [
       [
@@ -2054,14 +2060,14 @@
       ]
     ],
     "description": "create an immutable and exportable component snapshot, tagged with a release version.",
-    "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)",
+    "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags",
     "group": "development",
     "private": false,
     "remoteOp": true,
     "arguments": [
       {
-        "name": "component-names...",
-        "description": "a list of component names or component IDs (separated by space). By default, all modified are tagged."
+        "name": "patterns...",
+        "description": "a list of patterns (separated by space). run \"bit pattern --help\" to get more data about patterns. By default, all modified are tagged."
       }
     ],
     "examples": [
@@ -2352,7 +2358,7 @@
       [
         "s",
         "scope <scope-name>",
-        "name of the scope to test"
+        "DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
       ]
     ],
     "description": "test components in the workspace",
@@ -2362,7 +2368,7 @@
     "arguments": [
       {
         "name": "component-pattern",
-        "description": "the components to test (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. \nuse comma to separate patterns. e.g. \"ui/**, pages/**\"\nwrap the pattern with quotes (note that the \"!\" exclusion sign cannot be used here)"
+        "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"
       }
     ]
   },
@@ -2377,12 +2383,12 @@
       ]
     ],
     "description": "shows the API schema of a certain component.",
-    "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"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",
+    "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
     "group": "development",
     "private": false
   },
   {
-    "name": "check-types [pattern]",
+    "name": "check-types [component-pattern]",
     "alias": "",
     "options": [
       [
@@ -2399,7 +2405,13 @@
     "description": "check typescript types",
     "extendedDescription": "",
     "group": "development",
-    "private": false
+    "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": "aspect <sub-command>",
@@ -2421,7 +2433,7 @@
           ]
         ],
         "description": "list all aspects configured on component(s)",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect list \"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",
+        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect list \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "private": false
       },
@@ -2450,7 +2462,7 @@
         "alias": "",
         "options": [],
         "description": "set an aspect to component(s) with optional config.",
-        "extendedDescription": "enter the config as stringified JSON (e.g. '{\"foo\":\"bar\"}' ).\nif no config entered, the aspect will be set with empty config ({}).\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect set \"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",
+        "extendedDescription": "enter the config as stringified JSON (e.g. '{\"foo\":\"bar\"}' ).\nif no config entered, the aspect will be set with empty config ({}).\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect set \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "private": false
       },
@@ -2459,7 +2471,7 @@
         "alias": "",
         "options": [],
         "description": "unset an aspect from component(s).",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect 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",
+        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect unset \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "private": false
       },
@@ -2468,7 +2480,7 @@
         "alias": "",
         "options": [],
         "description": "update a version of an aspect",
-        "extendedDescription": "default to all components using the aspect, unless \"pattern\" is provided.\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> \"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\nexamples:\n\"bit aspect update scope.org/aspect '**/ui/**'\" - update \"ui\" components that use scope.org/aspect to the latest version\n\"bit aspect update scope.org/aspect@2.0.0\"      - updates all components using scope.org/aspect to version 2.0.0.",
+        "extendedDescription": "default to all components using the aspect, unless \"pattern\" is provided.\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n\nexamples:\n\"bit aspect update scope.org/aspect '**/ui/**'\" - update \"ui\" components that use scope.org/aspect to the latest version\n\"bit aspect update scope.org/aspect@2.0.0\"      - updates all components using scope.org/aspect to version 2.0.0.",
         "group": "development",
         "private": false
       }
@@ -2983,7 +2995,7 @@
       ]
     ],
     "description": "replaces the components from the local scope with the corresponding packages",
-    "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject \"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",
+    "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
     "group": "development",
     "private": false
   },

package/cli-reference.mdx

@@ -74,9 +74,10 @@ and a package.tgz file generated by pkg aspect.
 **Usage**: `aspect list [pattern]`
 
 **Description**: list all aspects configured on component(s)  
-you can use a `<pattern>` for multiple component ids, such as `bit aspect list "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit aspect list "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 | **Option** | **Option alias** | **Description**                                   |
 | ---------- | :--------------: | ------------------------------------------------- |
@@ -100,18 +101,20 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 **Description**: set an aspect to component(s) with optional config.  
 enter the config as stringified JSON (e.g. '{"foo":"bar"}' ).  
 if no config entered, the aspect will be set with empty config ({}).  
-you can use a `<pattern>` for multiple component ids, such as `bit aspect set "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit aspect set "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 ### aspect unset
 
 **Usage**: `aspect unset <pattern> <aspect-id>`
 
 **Description**: unset an aspect from component(s).  
-you can use a `<pattern>` for multiple component ids, such as `bit aspect unset "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit aspect 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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 ### aspect update
 
@@ -119,9 +122,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 **Description**: update a version of an aspect  
 default to all components using the aspect, unless "pattern" is provided.  
-you can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 examples:  
 "bit aspect update scope.org/aspect '**/ui/**'" - update "ui" components that use scope.org/aspect to the latest version  
@@ -134,7 +138,7 @@ examples:
 **Workspace only**: yes  
 **Description**: run set of tasks for build
 
-`bit build [pattern]`
+`bit build [component-pattern]`
 
 | **Option**                                                                                                  | **Option alias** | **Description**                                                                                 |
 | ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
@@ -206,7 +210,7 @@ with no args, only workspace's capsules are deleted
 **Workspace only**: yes  
 **Description**: check typescript types
 
-`bit check-types [pattern]`
+`bit check-types [component-pattern]`
 
 | **Option** | **Option alias** | **Description**                                           |
 | ---------- | :--------------: | --------------------------------------------------------- |
@@ -450,9 +454,10 @@ bit diff => compare all modified components to their model version
 **Alias**: `E`  
 **Workspace only**: yes  
 **Description**: replaces the components from the local scope with the corresponding packages  
-you can use a `<pattern>` for multiple component ids, such as `bit eject "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit eject "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 `bit eject <pattern>`
 
@@ -468,9 +473,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 **Workspace only**: yes  
 **Description**: eject components configuration (create a `component.json` file)  
-you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 `bit eject-conf <pattern>`
 
@@ -515,9 +521,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 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"  
+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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 ### envs replace
 
@@ -873,7 +880,14 @@ move files or directories of component(s)
 ## pattern
 
 **Workspace only**: yes  
-**Description**: list the component ids matching the given pattern
+**Description**: list the component ids matching the given pattern  
+this command helps validating a pattern before using it in other commands.  
+a pattern can be a simple component-id or component-name. e.g. "ui/button".  
+a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**".  
+to enter multiple patterns, separate them by a comma, e.g. "ui/_, lib/_"  
+to exclude, use "!". e.g. "ui/**, !ui/button"  
+always wrap the pattern with quotes to avoid collision with shell commands.  
+the matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)
 
 `bit pattern <pattern>`
 
@@ -993,9 +1007,10 @@ to assign a default-scope to this component, please use "--scope" flag
 
 **Workspace only**: yes  
 **Description**: shows the API schema of a certain component.  
-you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit schema "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 `bit schema <pattern>`
 
@@ -1019,9 +1034,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 **Description**: Sets components with a default-scope. If no component is specified, sets the workspace with a default scope  
 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.'
 
-you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
+you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "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>`.
+use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
 
 ### scope rename
 
@@ -1129,12 +1145,11 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 **Alias**: `t`  
 **Workspace only**: yes  
 **Description**: create an immutable and exportable component snapshot, tagged with a release version.  
-if no ids are provided, it will tag all new and modified components.  
-if 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  
-https://bit.dev/components/tags  
-you can use a pattern for multiple ids, such as bit tag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
+if no patterns are provided, it will tag all new and modified components.  
+if patterns are entered, you can specify a version per pattern using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major  
+https://bit.dev/components/tags
 
-`bit tag [component-names...]`
+`bit tag [patterns...]`
 
 | **Option**                   | **Option alias** | **Description**                                                                                                                |
 | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
@@ -1191,15 +1206,15 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 `bit test [component-pattern]`
 
-| **Option**             | **Option alias** | **Description**                                                      |
-| ---------------------- | :--------------: | -------------------------------------------------------------------- |
-| `--watch`              |       `-w`       | start the tester in watch mode.                                      |
-| `--debug`              |       `-d`       | start the tester in debug mode.                                      |
-| `--all`                |       `-a`       | test all components, not only new and modified                       |
-| `--junit <filepath>`   |                  | write tests results as JUnit XML format into the specified file path |
-| `--coverage`           |                  | show code coverage data                                              |
-| `--env <id>`           |       `-e`       | test only the given env                                              |
-| `--scope <scope-name>` |       `-s`       | name of the scope to test                                            |
+| **Option**             | **Option alias** | **Description**                                                                         |
+| ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
+| `--watch`              |       `-w`       | start the tester in watch mode.                                                         |
+| `--debug`              |       `-d`       | start the tester in debug mode.                                                         |
+| `--all`                |       `-a`       | test all components, not only new and modified                                          |
+| `--junit <filepath>`   |                  | write tests results as JUnit XML format into the specified file path                    |
+| `--coverage`           |                  | show code coverage data                                                                 |
+| `--env <id>`           |       `-e`       | test only the given env                                                                 |
+| `--scope <scope-name>` |       `-s`       | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
 
 ---
 

package/dist/cli-reference.json

@@ -1130,7 +1130,7 @@
                 "name": "unset <component-pattern>",
                 "options": [],
                 "description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
-                "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",
+                "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/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
                 "group": "development",
                 "arguments": [
                     {
@@ -1225,7 +1225,7 @@
                 "name": "set <scope-name> [component-pattern]",
                 "options": [],
                 "description": "Sets components with a default-scope. If no component is specified, sets the workspace with a default scope",
-                "extendedDescription": "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.'\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"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",
+                "extendedDescription": "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.'\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
                 "group": "development",
                 "arguments": [
                     {
@@ -1353,7 +1353,7 @@
             ]
         ],
         "description": "eject components configuration (create a `component.json` file)",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"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",
+        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "private": false
     },
@@ -1524,7 +1524,7 @@
             ]
         ],
         "description": "list the component ids matching the given pattern",
-        "extendedDescription": "",
+        "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
     },
@@ -1734,7 +1734,7 @@
         ]
     },
     {
-        "name": "build [pattern]",
+        "name": "build [component-pattern]",
         "alias": "",
         "options": [
             [
@@ -1776,7 +1776,13 @@
         "description": "run set of tasks for build",
         "extendedDescription": "",
         "group": "development",
-        "private": false
+        "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": "artifacts <pattern...>",
@@ -1924,7 +1930,7 @@
         "private": true
     },
     {
-        "name": "tag [component-names...]",
+        "name": "tag [patterns...]",
         "alias": "t",
         "options": [
             [
@@ -2054,14 +2060,14 @@
             ]
         ],
         "description": "create an immutable and exportable component snapshot, tagged with a release version.",
-        "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)",
+        "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags",
         "group": "development",
         "private": false,
         "remoteOp": true,
         "arguments": [
             {
-                "name": "component-names...",
-                "description": "a list of component names or component IDs (separated by space). By default, all modified are tagged."
+                "name": "patterns...",
+                "description": "a list of patterns (separated by space). run \"bit pattern --help\" to get more data about patterns. By default, all modified are tagged."
             }
         ],
         "examples": [
@@ -2352,7 +2358,7 @@
             [
                 "s",
                 "scope <scope-name>",
-                "name of the scope to test"
+                "DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
             ]
         ],
         "description": "test components in the workspace",
@@ -2362,7 +2368,7 @@
         "arguments": [
             {
                 "name": "component-pattern",
-                "description": "the components to test (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. \nuse comma to separate patterns. e.g. \"ui/**, pages/**\"\nwrap the pattern with quotes (note that the \"!\" exclusion sign cannot be used here)"
+                "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"
             }
         ]
     },
@@ -2377,12 +2383,12 @@
             ]
         ],
         "description": "shows the API schema of a certain component.",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"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",
+        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "private": false
     },
     {
-        "name": "check-types [pattern]",
+        "name": "check-types [component-pattern]",
         "alias": "",
         "options": [
             [
@@ -2399,7 +2405,13 @@
         "description": "check typescript types",
         "extendedDescription": "",
         "group": "development",
-        "private": false
+        "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": "aspect <sub-command>",
@@ -2421,7 +2433,7 @@
                     ]
                 ],
                 "description": "list all aspects configured on component(s)",
-                "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect list \"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",
+                "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect list \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
                 "group": "development",
                 "private": false
             },
@@ -2450,7 +2462,7 @@
                 "alias": "",
                 "options": [],
                 "description": "set an aspect to component(s) with optional config.",
-                "extendedDescription": "enter the config as stringified JSON (e.g. '{\"foo\":\"bar\"}' ).\nif no config entered, the aspect will be set with empty config ({}).\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect set \"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",
+                "extendedDescription": "enter the config as stringified JSON (e.g. '{\"foo\":\"bar\"}' ).\nif no config entered, the aspect will be set with empty config ({}).\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect set \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
                 "group": "development",
                 "private": false
             },
@@ -2459,7 +2471,7 @@
                 "alias": "",
                 "options": [],
                 "description": "unset an aspect from component(s).",
-                "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect 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",
+                "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit aspect unset \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
                 "group": "development",
                 "private": false
             },
@@ -2468,7 +2480,7 @@
                 "alias": "",
                 "options": [],
                 "description": "update a version of an aspect",
-                "extendedDescription": "default to all components using the aspect, unless \"pattern\" is provided.\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> \"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\nexamples:\n\"bit aspect update scope.org/aspect '**/ui/**'\" - update \"ui\" components that use scope.org/aspect to the latest version\n\"bit aspect update scope.org/aspect@2.0.0\"      - updates all components using scope.org/aspect to version 2.0.0.",
+                "extendedDescription": "default to all components using the aspect, unless \"pattern\" is provided.\nyou can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n\nexamples:\n\"bit aspect update scope.org/aspect '**/ui/**'\" - update \"ui\" components that use scope.org/aspect to the latest version\n\"bit aspect update scope.org/aspect@2.0.0\"      - updates all components using scope.org/aspect to version 2.0.0.",
                 "group": "development",
                 "private": false
             }
@@ -2983,7 +2995,7 @@
             ]
         ],
         "description": "replaces the components from the local scope with the corresponding packages",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject \"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",
+        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
         "group": "development",
         "private": false
     },