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

package/cli-reference.json

@@ -472,7 +472,7 @@
       [
         "t",
         "tests <file>/\"<file>,<file>\"",
-        "specify test files to track. use quotation marks to list files or use a glob pattern"
+        "LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern"
       ],
       [
         "n",
@@ -482,7 +482,7 @@
       [
         "e",
         "exclude <file>/\"<file>,<file>\"",
-        "exclude file from being tracked. use quotation marks to list files or use a glob pattern"
+        "LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern"
       ],
       [
         "o",
@@ -516,7 +516,7 @@
     "private": true
   },
   {
-    "name": "untag [id] [version]",
+    "name": "untag [component-name] [component-version]",
     "alias": "",
     "options": [
       [
@@ -535,19 +535,19 @@
         "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
       ]
     ],
-    "description": "revert versions tagged for component(s)",
+    "description": "revert tagged or snapped versions for component(s)",
     "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "development",
     "private": false
   },
   {
-    "name": "move <existing-dir> <new-dir>",
+    "name": "move <current-component-dir> <new-component-dir>",
     "alias": "mv",
     "options": [
       [
         "c",
         "component",
-        "move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
+        "LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
       ]
     ],
     "description": "move a component to a different filesystem path",
@@ -556,7 +556,7 @@
     "private": false
   },
   {
-    "name": "remove <ids...>",
+    "name": "remove <component-ids...>",
     "alias": "rm",
     "options": [
       [
@@ -567,7 +567,7 @@
       [
         "t",
         "track",
-        "keep tracking component (default = false)"
+        "keep tracking component in .bitmap (default = false), helps transform a tagged-component to new"
       ],
       [
         "d",
@@ -590,7 +590,7 @@
         "skip confirmation"
       ]
     ],
-    "description": "remove component(s) from your workspace, or a remote scope",
+    "description": "remove component(s) from the workspace, or a remote scope",
     "extendedDescription": "https://bit.dev/docs/components/removing-components\nyou can use a pattern for multiple ids, such as bit remove \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "collaborate",
     "private": false,
@@ -721,7 +721,7 @@
         "show tables instead of plain text for dependencies diff"
       ]
     ],
-    "description": "show diff between components files",
+    "description": "show the diff between the components' source files and config",
     "extendedDescription": "bit diff => compare all modified components to their model version\n  bit diff [ids...] => compare the specified components against their modified states\n  bit diff [id] [version] => compare the specified version to used or modified files\n  bit diff [id] [version] [to_version] => compare the specified version files to to_version files\n  you can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
     "group": "development",
     "private": false
@@ -752,11 +752,11 @@
       ],
       [
         "",
-        "machine-name <string>",
+        "machine-name <name>",
         "specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token)"
       ]
     ],
-    "description": "log the CLI into Bit Cloud",
+    "description": "log in to Bit cloud",
     "extendedDescription": "",
     "group": "general",
     "private": false,
@@ -1265,7 +1265,13 @@
     "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
+    "private": false,
+    "arguments": [
+      {
+        "name": "packages...",
+        "description": "a list of packages to install (separated by spaces)"
+      }
+    ]
   },
   {
     "name": "update",
@@ -1316,7 +1322,7 @@
     "alias": "",
     "options": [],
     "description": "manage capsules",
-    "extendedDescription": "a capsule is a directory contains the component code, isolated from the workspace.\nnormally, capsules are created during the build process, the component files are copied and the packages are installed\nvia the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for\nother users after publishing/exporting them.",
+    "extendedDescription": "a capsule is a directory containing the component code, isolated from the workspace.\nnormally, capsules are created during the build process, the component files are copied and the packages are installed\nvia the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for\nother users after publishing/exporting them.",
     "group": "capsules",
     "private": false,
     "commands": [
@@ -1330,13 +1336,13 @@
             "json format"
           ]
         ],
-        "description": "list all capsules",
+        "description": "list the capsules generated for this workspace",
         "extendedDescription": "",
         "group": "capsules",
         "private": false
       },
       {
-        "name": "create [componentIds...]",
+        "name": "create [component-id...]",
         "alias": "",
         "options": [
           [
@@ -1380,7 +1386,7 @@
             "npm, yarn or pnpm, default to npm"
           ]
         ],
-        "description": "create capsules",
+        "description": "create capsules for components",
         "extendedDescription": "",
         "group": "capsules",
         "private": false
@@ -1414,7 +1420,7 @@
       [
         "v",
         "verbose",
-        "showing npm verbose output for inspection and prints stack trace"
+        "show npm verbose output for inspection and print the stack trace"
       ],
       [
         "",
@@ -1427,13 +1433,13 @@
         "EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project"
       ]
     ],
-    "description": "watch a set of components",
+    "description": "automatically recompile modified components (on save)",
     "extendedDescription": "",
     "group": "development",
     "private": false
   },
   {
-    "name": "link [ids...]",
+    "name": "link [component-names...]",
     "alias": "",
     "options": [
       [
@@ -1462,10 +1468,16 @@
         "skip fetch missing objects from remotes before linking"
       ]
     ],
-    "description": "link components and core aspects",
+    "description": "create links in the node_modules directory, to core aspects and to components in the workspace",
     "extendedDescription": "https://bit.dev/docs/workspace/component-links",
     "group": "development",
-    "private": false
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-names...",
+        "description": "names or IDs of the components to link"
+      }
+    ]
   },
   {
     "name": "pattern <pattern>",
@@ -1640,6 +1652,16 @@
     "extendedDescription": "",
     "group": "development",
     "private": false,
+    "arguments": [
+      {
+        "name": "template-name",
+        "description": "the template for generating the component \n(run 'bit templates' for a list of available templates)"
+      },
+      {
+        "name": "component-names...",
+        "description": "a list of component names to generate"
+      }
+    ],
     "examples": [
       {
         "cmd": "bit create react ui/button",
@@ -1921,7 +1943,7 @@
     "private": true
   },
   {
-    "name": "tag [patterns...]",
+    "name": "tag [component-patterns...]",
     "alias": "t",
     "options": [
       [
@@ -2057,8 +2079,8 @@
     "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."
+        "name": "component-patterns...",
+        "description": "a list of component names, IDs or patterns (separated by space). run \"bit pattern --help\" to get more data about patterns. By default, all modified are tagged."
       }
     ],
     "examples": [
@@ -2424,12 +2446,18 @@
           ]
         ],
         "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/**\"`.\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",
+        "extendedDescription": "",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+          {
+            "name": "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": "get <component-id>",
+        "name": "get <component-name>",
         "alias": "",
         "options": [
           [
@@ -2443,37 +2471,87 @@
             "format as json"
           ]
         ],
-        "description": "show aspects' data and configuration of the given component",
+        "description": "list the aspects set on a component, as well as their config and data",
         "extendedDescription": "",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+          {
+            "name": "component-name",
+            "description": "the component name or component id"
+          }
+        ]
       },
       {
         "name": "set <pattern> <aspect-id> [config]",
         "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/**\"`.\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",
+        "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
+        "extendedDescription": "",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+          {
+            "name": "pattern",
+            "description": "the components to extend. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
+          },
+          {
+            "name": "aspect-id",
+            "description": "the aspect's component id"
+          },
+          {
+            "name": "config",
+            "description": "the aspect config. enter the config as a stringified JSON (e.g. '{\"foo\":\"bar\"}' ). when no config is provided, an aspect is set with an empty config ({})."
+          }
+        ]
       },
       {
         "name": "unset <pattern> <aspect-id>",
         "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/**\"`.\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",
+        "extendedDescription": "",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+          {
+            "name": "pattern",
+            "description": "the components to target. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
+          },
+          {
+            "name": "aspect-id",
+            "description": "the aspect's component id"
+          }
+        ]
       },
       {
         "name": "update <aspect-id> [pattern]",
         "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/**\"`.\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.",
+        "extendedDescription": "",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+          {
+            "name": "aspect-id",
+            "description": "the aspect's component id"
+          },
+          {
+            "name": "pattern",
+            "description": "the components to update (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
+          }
+        ],
+        "examples": [
+          {
+            "cmd": "update scope.org/aspect '**/ui/**'",
+            "description": "update \"ui\" components that use scope.org/aspect to use its latest version"
+          },
+          {
+            "cmd": "bit aspect update scope.org/aspect@2.0.0",
+            "description": "update all components that use scope.org/aspect to version 2.0.0 (of this aspect)."
+          }
+        ]
       }
     ]
   },
@@ -2555,31 +2633,41 @@
     "skipWorkspace": true
   },
   {
-    "name": "rename <source-name> <target-name>",
+    "name": "rename <current-name> <new-name>",
     "alias": "",
     "options": [
       [
         "s",
-        "scope <string>",
+        "scope <scope-name>",
         "default scope for the newly created component"
       ],
       [
         "p",
-        "path <string>",
+        "path <relative-path>",
         "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
       ],
       [
         "r",
         "refactor",
-        "change the source code of all components using this component with the new package-name"
+        "update the import/require statements in all dependent components (in the same workspace)"
       ]
     ],
-    "description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the source-component",
-    "extendedDescription": "the `<target-name>` should include the component-name only, without the scope-name.\nto assign a default-scope to this component, please use \"--scope\" flag",
+    "description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component",
+    "extendedDescription": "",
     "group": "collaborate",
     "private": false,
     "remoteOp": true,
-    "skipWorkspace": true
+    "skipWorkspace": true,
+    "arguments": [
+      {
+        "name": "current-name",
+        "description": "the current component name (without its scope name)"
+      },
+      {
+        "name": "new-name",
+        "description": "the new component name (without its scope name)"
+      }
+    ]
   },
   {
     "name": "fork <source-component-id> [target-component-name]",
@@ -2853,7 +2941,13 @@
         "description": "remove lanes",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true
+        "private": true,
+        "arguments": [
+          {
+            "name": "lanes...",
+            "description": "A list of lane names, separated by spaces"
+          }
+        ]
       },
       {
         "name": "change-scope <lane-name> <remote-scope-name>",
@@ -2901,7 +2995,17 @@
         "extendedDescription": "",
         "group": "ungrouped",
         "private": true,
-        "skipWorkspace": false
+        "skipWorkspace": false,
+        "arguments": [
+          {
+            "name": "component-id",
+            "description": "the component name or id of the component to use as the lane's readme"
+          },
+          {
+            "name": "lane-name",
+            "description": "the lane to attach the readme to (defaults to the current lane)"
+          }
+        ]
       },
       {
         "name": "remove-readme [laneName]",
@@ -2926,7 +3030,13 @@
         "description": "import a remote lane to your workspace",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true
+        "private": true,
+        "arguments": [
+          {
+            "name": "lane",
+            "description": "the remote lane name"
+          }
+        ]
       }
     ]
   },
@@ -2966,7 +3076,7 @@
     "private": true
   },
   {
-    "name": "eject <pattern>",
+    "name": "eject <component-pattern>",
     "alias": "E",
     "options": [
       [
@@ -2985,10 +3095,16 @@
         "keep the component files in the workspace intact"
       ]
     ],
-    "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/**\"`.\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",
+    "description": "replace components maintained in the workspace with their corresponding packages",
+    "extendedDescription": "",
     "group": "development",
-    "private": false
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-pattern",
+        "description": "component name, component id, or component pattern.\nuse component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+      }
+    ]
   },
   {
     "name": "resume-export <export-id> <remotes...>",
@@ -3042,7 +3158,7 @@
       [
         "",
         "origin-directly",
-        "HARMONY ONLY. avoid export to the central hub, instead, export directly to the original scopes. not recommended!"
+        "EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended!"
       ],
       [
         "",