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

package/cli-reference.json

@@ -65,52 +65,6 @@
     "private": false,
     "skipWorkspace": true
   },
-  {
-    "name": "list [remote-scope]",
-    "alias": "ls",
-    "options": [
-      [
-        "i",
-        "ids",
-        "show only component ids unformatted"
-      ],
-      [
-        "s",
-        "scope",
-        "show only components stored in the local scope, including indirect dependencies"
-      ],
-      [
-        "b",
-        "bare",
-        "DEPRECATED. use --raw instead"
-      ],
-      [
-        "r",
-        "raw",
-        "show raw output (only components ids, no styling)"
-      ],
-      [
-        "o",
-        "outdated",
-        "show latest versions from remotes"
-      ],
-      [
-        "j",
-        "json",
-        "show the output in JSON format"
-      ],
-      [
-        "n",
-        "namespace <string>",
-        "show only specified namespace by using wildcards"
-      ]
-    ],
-    "description": "list components on a workspace, local scope or a remote scope.",
-    "extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
-    "group": "discover",
-    "private": false,
-    "skipWorkspace": true
-  },
   {
     "name": "config",
     "alias": "",
@@ -997,23 +951,29 @@
     "private": false
   },
   {
-    "name": "use [ids...]",
+    "name": "use [component-ids...]",
     "alias": "",
     "options": [],
-    "description": "set up aspects in the workspace/scope config",
+    "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
     "extendedDescription": "",
     "group": "collaborate",
     "private": false,
-    "remoteOp": true
+    "remoteOp": true,
+    "arguments": [
+      {
+        "name": "component-ids...",
+        "description": "the component IDs of the aspects"
+      }
+    ]
   },
   {
-    "name": "show <id>",
+    "name": "show <component-name>",
     "alias": "",
     "options": [
       [
         "j",
         "json",
-        "return the component data in json format"
+        "return the component data in a json format"
       ],
       [
         "l",
@@ -1028,34 +988,25 @@
       [
         "c",
         "compare",
-        "compare current file system component to latest tagged component [default=latest]. only works in legacy."
+        "compare current file system component to the latest tagged component [default=latest]. only works in legacy."
       ]
     ],
-    "description": "show a component",
+    "description": "display the component's essential information",
     "extendedDescription": "",
     "group": "info",
-    "private": false
-  },
-  {
-    "name": "globals",
-    "alias": "",
-    "options": [
-      [
-        "j",
-        "json",
-        "json format"
-      ]
-    ],
-    "description": "list all globals",
-    "extendedDescription": "",
-    "group": "workspace",
-    "private": false
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-name",
+        "description": "component name or component id"
+      }
+    ]
   },
   {
     "name": "envs",
     "alias": "env",
     "options": [],
-    "description": "list all components envs",
+    "description": "list all components maintained by the workspace and their corresponding envs",
     "extendedDescription": "",
     "group": "development",
     "private": false,
@@ -1070,52 +1021,102 @@
         "private": false
       },
       {
-        "name": "get <name>",
+        "name": "get <component-name>",
         "alias": "",
         "options": [],
-        "description": "show component's env details",
+        "description": "show information about a component's env",
         "extendedDescription": "",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+          {
+            "name": "component-name",
+            "description": "the 'component name' or 'component id' of the component its env you'd like to inspect"
+          }
+        ]
       },
       {
-        "name": "set <pattern> <env>",
+        "name": "set <component-pattern> <env>",
         "options": [],
-        "description": "set an environment for component(s)",
-        "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit env 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",
-        "group": "development"
+        "description": "Sets one or more components with a development environment (env)",
+        "group": "development",
+        "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"
+          },
+          {
+            "name": "env",
+            "description": "the env's component id (include version for non-core envs. e.g, `teambit.community/envs/community-react@1.95.13`)"
+          }
+        ],
+        "examples": [
+          {
+            "cmd": "set ui/button teambit.react/react",
+            "description": "configures 'ui/button' to use the 'teambit.react/react' env"
+          },
+          {
+            "cmd": "set ui/button teambit.community/envs/community-mdx@1.95.16",
+            "description": "configures 'ui/button' to use the (non-core) 'teambit.community/envs/community-mdx@1.95.16' env"
+          },
+          {
+            "cmd": "set \"ui/**\" teambit.react/react",
+            "description": "configures all components that have the 'ui' namespace to use the teambit.react/react env"
+          }
+        ]
       },
       {
-        "name": "unset <pattern>",
+        "name": "unset <component-pattern>",
         "options": [],
-        "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"
+        "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/**\"`.\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": [
+          {
+            "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": "replace <old-env> <new-env>",
+        "name": "replace <current-env> <new-env>",
         "options": [],
         "description": "replace an existing env with another env for all components using the old env",
         "group": "development",
         "arguments": [
           {
-            "name": "old-env",
-            "description": "current environment id"
+            "name": "current-env",
+            "description": "the component id of the current env"
           },
           {
             "name": "new-env",
-            "description": "target environment id"
+            "description": "the component id of the new env"
           }
         ],
         "examples": [
           {
             "cmd": "replace teambit.harmony/aspect teambit.harmony/node",
-            "description": "all components using aspect env, will be replaced with node env"
+            "description": "components configured to use the 'aspect' env will be configured to use the 'node' env, instead"
           }
         ]
       }
     ]
   },
+  {
+    "name": "globals",
+    "alias": "",
+    "options": [
+      [
+        "j",
+        "json",
+        "json format"
+      ]
+    ],
+    "description": "list all globals",
+    "extendedDescription": "",
+    "group": "workspace",
+    "private": false
+  },
   {
     "name": "start [type] [pattern]",
     "alias": "c",
@@ -1127,7 +1128,7 @@
       ],
       [
         "p",
-        "port [number]",
+        "port [port-number]",
         "port of the UI server."
       ],
       [
@@ -1138,7 +1139,7 @@
       [
         "v",
         "verbose",
-        "showing verbose output for inspection and prints stack trace"
+        "show verbose output for inspection and prints stack trace"
       ],
       [
         "",
@@ -1151,7 +1152,7 @@
         "skip the auto-compilation before starting the web-server"
       ]
     ],
-    "description": "Start a dev environment for a workspace or a specific component",
+    "description": "run the ui/development server",
     "extendedDescription": "",
     "group": "development",
     "private": false
@@ -1169,20 +1170,30 @@
     "name": "scope <sub-command>",
     "alias": "",
     "options": [],
-    "description": "EXPERIMENTAL. manage scope-name",
+    "description": "EXPERIMENTAL. manage the scope-name for components",
     "extendedDescription": "",
     "group": "development",
     "private": false,
     "commands": [
       {
-        "name": "set <scope-name> [pattern]",
+        "name": "set <scope-name> [component-pattern]",
         "options": [],
-        "description": "set the default-scope",
-        "extendedDescription": "set a new scope in the workspace.jsonc.\nif \"pattern\" is provided, the default-scope will be set to the new components matching the criteria.\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",
-        "group": "development"
+        "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/**\"`.\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": [
+          {
+            "name": "scope-name",
+            "description": "the scope name to use as the default scope"
+          },
+          {
+            "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": "rename <old-name> <new-name>",
+        "name": "rename <current-scope-name> <new-scope-name>",
         "options": [
           [
             "r",
@@ -1190,8 +1201,18 @@
             "change the source code of all components using the original scope-name with the new scope-name"
           ]
         ],
-        "description": "rename a scope for components using the old-name, optionally change the dependencies source-code",
-        "group": "development"
+        "description": "Renames the scope name for all components with the specified 'current scope name'",
+        "group": "development",
+        "arguments": [
+          {
+            "name": "current-scope-name",
+            "description": "the scope name to be replaced by another scope name"
+          },
+          {
+            "name": "new-scope-name",
+            "description": "a new scope name to replace the current scope name"
+          }
+        ]
       },
       {
         "name": "fork <original-scope> <new-scope>",
@@ -1241,8 +1262,8 @@
         "install all missing peer dependencies"
       ]
     ],
-    "description": "install development workspace dependencies",
-    "extendedDescription": "",
+    "description": "installs workspace dependencies",
+    "extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
     "group": "development",
     "private": false
   },
@@ -1286,7 +1307,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
   },
@@ -1457,23 +1478,60 @@
       ]
     ],
     "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
   },
   {
-    "name": "import [ids...]",
+    "name": "list [remote-scope]",
+    "alias": "ls",
+    "options": [
+      [
+        "i",
+        "ids",
+        "show only component ids unformatted"
+      ],
+      [
+        "s",
+        "scope",
+        "show only components stored in the local scope, including indirect dependencies"
+      ],
+      [
+        "o",
+        "outdated",
+        "show latest versions from remotes"
+      ],
+      [
+        "j",
+        "json",
+        "show the output in JSON format"
+      ],
+      [
+        "n",
+        "namespace <string>",
+        "show only specified namespace by using wildcards"
+      ]
+    ],
+    "description": "list components on a workspace, local scope or a remote scope.",
+    "extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
+    "group": "discover",
+    "private": false,
+    "remoteOp": true,
+    "skipWorkspace": true
+  },
+  {
+    "name": "import [component-ids...]",
     "alias": "",
     "options": [
       [
         "p",
         "path <path>",
-        "import components into a specific directory"
+        "import components into a specific directory (a relative path in the workspace)"
       ],
       [
         "o",
         "objects",
-        "import components objects only, don't write the components to the file system. This is a default behavior for import with no id"
+        "import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument"
       ],
       [
         "d",
@@ -1488,7 +1546,7 @@
       [
         "v",
         "verbose",
-        "showing verbose output for inspection"
+        "show verbose output for inspection"
       ],
       [
         "j",
@@ -1498,7 +1556,7 @@
       [
         "",
         "conf",
-        "write the configuration file (component.json) of the component (harmony components only)"
+        "write the configuration file (component.json) of the component"
       ],
       [
         "",
@@ -1536,14 +1594,20 @@
         "relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
       ]
     ],
-    "description": "import components into your workspace",
+    "description": "import components from remote scopes to the local workspace",
     "extendedDescription": "https://bit.dev/docs/components/importing-components\nyou can use a pattern for multiple ids, such as bit import \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "collaborate",
     "private": false,
-    "remoteOp": true
+    "remoteOp": true,
+    "arguments": [
+      {
+        "name": "component-ids...",
+        "description": "a list of component IDs (separated by space) to import"
+      }
+    ]
   },
   {
-    "name": "create <templateName> <componentNames...>",
+    "name": "create <template-name> <component-names...>",
     "alias": "",
     "options": [
       [
@@ -1572,10 +1636,28 @@
         "set the component's environment. (overrides the env from variants and the template)"
       ]
     ],
-    "description": "create a new component from a template",
+    "description": "create a new component (source files and config) using a template.",
     "extendedDescription": "",
     "group": "development",
-    "private": false
+    "private": false,
+    "examples": [
+      {
+        "cmd": "bit create react ui/button",
+        "description": "creates a component named 'ui/button' using the 'react' template"
+      },
+      {
+        "cmd": "bit create react ui/button pages/register",
+        "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
+      },
+      {
+        "cmd": "bit create react ui/button --scope my-org.my-scope",
+        "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
+      },
+      {
+        "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
+        "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
+      }
+    ]
   },
   {
     "name": "templates",
@@ -1593,17 +1675,17 @@
     "private": false
   },
   {
-    "name": "new <templateName> <workspaceName>",
+    "name": "new <template-name> <workspace-name>",
     "alias": "",
     "options": [
       [
         "a",
-        "aspect <string>",
+        "aspect <aspect-id>",
         "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
       ],
       [
         "d",
-        "default-scope <string>",
+        "default-scope <scope-name>",
         "set defaultScope in the new workspace.jsonc"
       ],
       [
@@ -1623,17 +1705,27 @@
       ],
       [
         "",
-        "load-from <string>",
+        "load-from <path-to-template>",
         "path to the workspace containing the template. helpful during a development of a workspace-template"
       ]
     ],
-    "description": "Create a new workspace from a template",
+    "description": "create a new workspace from a template",
     "extendedDescription": "",
     "group": "start",
-    "private": false
+    "private": false,
+    "arguments": [
+      {
+        "name": "template-name",
+        "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
+      },
+      {
+        "name": "workspace-name",
+        "description": "the name for the new workspace and workspace directory"
+      }
+    ]
   },
   {
-    "name": "build [pattern]",
+    "name": "build [component-pattern]",
     "alias": "",
     "options": [
       [
@@ -1675,7 +1767,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...>",
@@ -1823,13 +1921,13 @@
     "private": true
   },
   {
-    "name": "tag [id...]",
+    "name": "tag [patterns...]",
     "alias": "t",
     "options": [
       [
         "m",
         "message <message>",
-        "log message describing the user changes"
+        "a log message describing latest changes"
       ],
       [
         "",
@@ -1839,7 +1937,7 @@
       [
         "",
         "editor [editor]",
-        "EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim"
+        "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
       ],
       [
         "v",
@@ -1952,11 +2050,17 @@
         "DEPRECATED. use --disable-tag-pipeline instead"
       ]
     ],
-    "description": "record component changes and lock versions",
-    "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)",
+    "description": "create an immutable and exportable component snapshot, tagged with a release version.",
+    "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": "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": [
       {
         "cmd": "tag --ver 1.0.0",
@@ -1965,13 +2069,13 @@
     ]
   },
   {
-    "name": "snap [id]",
+    "name": "snap [component-name]",
     "alias": "",
     "options": [
       [
         "m",
         "message <message>",
-        "log message describing the user changes"
+        "log message describing the latest changes"
       ],
       [
         "",
@@ -2019,10 +2123,16 @@
         "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
       ]
     ],
-    "description": "EXPERIMENTAL. record component changes",
+    "description": "EXPERIMENTAL. create an immutable and exportable component snapshot (no release version)",
     "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
+    "private": true,
+    "arguments": [
+      {
+        "name": "component_name",
+        "description": "component names or component ID (defaults to all components)"
+      }
+    ]
   },
   {
     "name": "merge [values...]",
@@ -2089,13 +2199,13 @@
         "in case issues found, exit with code 1"
       ]
     ],
-    "description": "show the working area component(s) status",
-    "extendedDescription": "https://bit.dev/docs/workspace/workspace-status",
+    "description": "present the current status of components in the workspace, and notifies when issues are detected",
+    "extendedDescription": "",
     "group": "development",
     "private": false
   },
   {
-    "name": "compile [component...]",
+    "name": "compile [component-names...]",
     "alias": "",
     "options": [
       [
@@ -2119,13 +2229,19 @@
         "delete existing dist folder before writing new compiled files"
       ]
     ],
-    "description": "compile components in the development workspace",
+    "description": "compile components in the workspace",
     "extendedDescription": "",
     "group": "development",
-    "private": false
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-names...",
+        "description": "a list of component names or component IDs (defaults to all components)"
+      }
+    ]
   },
   {
-    "name": "run <app>",
+    "name": "run <app-name>",
     "alias": "c",
     "options": [
       [
@@ -2144,10 +2260,16 @@
         "avoid running the watch process that compiles components in the background"
       ]
     ],
-    "description": "run an application",
+    "description": "run an app (independent of bit's dev server)",
     "extendedDescription": "",
     "group": "apps",
-    "private": false
+    "private": false,
+    "arguments": [
+      {
+        "name": "app-name",
+        "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
+      }
+    ]
   },
   {
     "name": "app-list",
@@ -2168,7 +2290,7 @@
     "name": "app <sub-command>",
     "alias": "",
     "options": [],
-    "description": "manage applications",
+    "description": "Manages apps",
     "extendedDescription": "",
     "group": "apps",
     "private": false,
@@ -2183,7 +2305,7 @@
             "return the component data in json format"
           ]
         ],
-        "description": "list all registered applications",
+        "description": "list all registered apps",
         "extendedDescription": "",
         "group": "apps",
         "private": false
@@ -2191,7 +2313,7 @@
     ]
   },
   {
-    "name": "test [pattern]",
+    "name": "test [component-pattern]",
     "alias": "at",
     "options": [
       [
@@ -2226,14 +2348,20 @@
       ],
       [
         "s",
-        "scope <scope>",
-        "name of the scope to test"
+        "scope <scope-name>",
+        "DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
       ]
     ],
-    "description": "test set of components in your workspace",
+    "description": "test components in the workspace",
     "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": "schema <pattern>",
@@ -2246,12 +2374,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": [
       [
@@ -2268,7 +2396,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>",
@@ -2290,7 +2424,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
       },
@@ -2319,7 +2453,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
       },
@@ -2328,7 +2462,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
       },
@@ -2337,7 +2471,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
       }
@@ -2448,34 +2582,44 @@
     "skipWorkspace": true
   },
   {
-    "name": "fork <source-id> [target-name]",
+    "name": "fork <source-component-id> [target-component-name]",
     "alias": "",
     "options": [
       [
         "s",
         "scope <string>",
-        "default scope for the newly created component"
+        "default scope for the new component"
       ],
       [
         "p",
         "path <string>",
-        "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
+        "relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>`"
       ],
       [
         "r",
         "refactor",
-        "change the source code of all components using the original component with the new package-name"
+        "update the import/require statements in all dependent components (in the same workspace)"
       ]
     ],
-    "description": "EXPERIMENTAL. create a new component out of an existing one",
-    "extendedDescription": "note that [target-name] is the name only without the scope.\nto set the default-scope, please use --scope flag",
+    "description": "EXPERIMENTAL. create a new component out of an existing one (copies source files and config)",
+    "extendedDescription": "",
     "group": "collaborate",
     "private": false,
     "remoteOp": true,
-    "skipWorkspace": true
+    "skipWorkspace": true,
+    "arguments": [
+      {
+        "name": "source-component-id",
+        "description": "the component id of the source component"
+      },
+      {
+        "name": "target-component-name",
+        "description": "the name for the new component (component name without scope). to set a different scope, use the '--scope' flag"
+      }
+    ]
   },
   {
-    "name": "lane [name]",
+    "name": "lane [lane-name]",
     "alias": "",
     "options": [
       [
@@ -2523,11 +2667,11 @@
           [
             "j",
             "json",
-            "show lanes details in json format"
+            "show lanes details in a json format"
           ],
           [
             "r",
-            "remote <string>",
+            "remote <remote-scope-name>",
             "show remote lanes"
           ],
           [
@@ -2538,7 +2682,7 @@
           [
             "",
             "not-merged",
-            "show not merged lanes"
+            "show lanes that are not merged"
           ]
         ],
         "description": "list lanes",
@@ -2584,7 +2728,7 @@
         "private": true
       },
       {
-        "name": "show <name>",
+        "name": "show <lane-name>",
         "alias": "",
         "options": [
           [
@@ -2606,21 +2750,21 @@
         "skipWorkspace": true
       },
       {
-        "name": "create <name>",
+        "name": "create <lane-name>",
         "alias": "",
         "options": [
           [
             "",
-            "remote-scope <string>",
+            "remote-scope <scope-name>",
             "remote scope where this lane will be exported to, default to the defaultScope (can be changed later with \"bit lane change-scope\")"
           ],
           [
             "",
-            "alias <string>",
-            "a local alias to refer to this lane, default to the <name> (can be added later with \"bit lane alias\")"
+            "alias <name>",
+            "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
           ]
         ],
-        "description": "create and switch to a new lane",
+        "description": "creates a new lane and switches to it",
         "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
         "group": "ungrouped",
         "private": true
@@ -2631,7 +2775,7 @@
         "options": [
           [
             "",
-            "remote <name>",
+            "remote <scope-name>",
             "remote scope name"
           ],
           [
@@ -2687,7 +2831,7 @@
         "remoteOp": true
       },
       {
-        "name": "remove <lane...>",
+        "name": "remove <lanes...>",
         "alias": "",
         "options": [
           [
@@ -2712,10 +2856,10 @@
         "private": true
       },
       {
-        "name": "change-scope <lane-name> <remote-scope>",
+        "name": "change-scope <lane-name> <remote-scope-name>",
         "alias": "",
         "options": [],
-        "description": "change the remote scope of a lane",
+        "description": "changes the remote scope of a lane",
         "extendedDescription": "",
         "group": "ungrouped",
         "private": true
@@ -2724,7 +2868,7 @@
         "name": "alias <lane-name> <alias>",
         "alias": "",
         "options": [],
-        "description": "add an alias to a lane",
+        "description": "adds an alias to a lane",
         "extendedDescription": "an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.\nit is useful when having multiple lanes with the same name, but with different remote scopes.",
         "group": "ungrouped",
         "private": true
@@ -2750,10 +2894,10 @@
         "skipWorkspace": true
       },
       {
-        "name": "add-readme <componentId> [laneName]",
+        "name": "add-readme <component-name> [lane-name]",
         "alias": "",
         "options": [],
-        "description": "EXPERIMENTAL. add lane readme component",
+        "description": "EXPERIMENTAL. adds a readme component to a lane",
         "extendedDescription": "",
         "group": "ungrouped",
         "private": true,
@@ -2842,7 +2986,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
   },
@@ -2857,18 +3001,18 @@
     "remoteOp": true
   },
   {
-    "name": "export [remote] [id...]",
+    "name": "export [remote] [component-names...]",
     "alias": "e",
     "options": [
       [
         "e",
         "eject",
-        "replaces the exported components from the local scope with the corresponding packages"
+        "replace the exported components with their corresponding packages (to use these components without further maintaining them)"
       ],
       [
         "a",
         "all",
-        "export all components include non-staged"
+        "export all components, including non-staged"
       ],
       [
         "d",
@@ -2916,11 +3060,21 @@
         "show output in json format"
       ]
     ],
-    "description": "Export components to a remote scope",
+    "description": "export components from the workspace to remote scopes",
     "extendedDescription": "bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well\n`bit export [id...]` => export the given ids to their current scope\n\nhttps://bit.dev/docs/components/exporting-components\nyou 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)",
     "group": "collaborate",
     "private": false,
-    "remoteOp": true
+    "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."
+      }
+    ]
   },
   {
     "name": "update-dependencies <data>",