@teambit/harmony.content.cli-reference 1.95.116 → 1.95.118

package/cli-reference.json

@@ -1577,6 +1577,11 @@
         "",
         "add-missing-peers [addMissingPeers]",
         "install all missing peer dependencies"
+      ],
+      [
+        "",
+        "no-optional [noOptional]",
+        "do not install optional dependencies (works with pnpm only)"
       ]
     ],
     "description": "installs workspace dependencies",
@@ -2831,7 +2836,7 @@
           ]
         ],
         "description": "merge a local or a remote lane",
-        "extendedDescription": "if the <lane> exists locally, it will be merged from the local lane.\notherwise, it will fetch the lane from the remote and merge it.\nin case the <lane> exists locally but you want to merge the remote version of it, use --remote flag.\nwhen the current and the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
+        "extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
         "private": true,
         "remoteOp": true,
         "arguments": [
@@ -2993,6 +2998,36 @@
           }
         ]
       },
+      {
+        "name": "unset <component-pattern> <package...>",
+        "alias": "",
+        "options": [
+          [
+            "d",
+            "dev",
+            "unset from devDependencies"
+          ],
+          [
+            "p",
+            "peer",
+            "unset from peerDependencies"
+          ]
+        ],
+        "description": "unset a dependency to component(s) that was previously set by \"bit deps set\"",
+        "extendedDescription": "",
+        "group": "info",
+        "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": "package...",
+            "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
+          }
+        ]
+      },
       {
         "name": "debug <component-name>",
         "alias": "",

package/cli-reference.mdx

@@ -1,11 +1,26 @@
 # CLI Reference
 
-Commands that are marked as workspace only must be executed inside a workspace. Commands that are marked as not workspace only, can be executed from anywhere and will run on a remote server.
+Run the following to list all available Bit commands (alternatively, use the `-h` alias, instead of `--help`):
+
+```sh
+bit --help
+```
+
+Run the following to get help on a specific command:
+
+```sh
+bit COMMAND --help
+```
+
+Run the following to get help on a specific sub-command:
+
+```sh
+bit COMMAND SUB_COMMAND --help
+```
 
 ## add
 
 **Alias**: `a`  
-**Workspace only**: yes  
 **Description**: Add any subset of files to be tracked as a component(s).  
 Learn the recommended workflow for tracking directories as components, in the link below.
 
@@ -23,7 +38,6 @@ Learn the recommended workflow for tracking directories as components, in the li
 
 ## app
 
-**Workspace only**: yes  
 **Description**: Manages apps
 
 `bit app <sub-command>`
@@ -55,7 +69,6 @@ Learn the recommended workflow for tracking directories as components, in the li
 
 ## artifacts
 
-**Workspace only**: yes  
 **Description**: list and download components artifacts  
 artifacts are created on isolated capsules during tag or snap commands.  
 example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester  
@@ -74,7 +87,6 @@ and a package.tgz file generated by pkg aspect.
 
 ## aspect
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. manage aspects
 
 `bit aspect <sub-command>`
@@ -126,7 +138,6 @@ and a package.tgz file generated by pkg aspect.
 
 ## build
 
-**Workspace only**: yes  
 **Description**: run set of tasks for build
 
 `bit build [component-pattern]`
@@ -147,7 +158,6 @@ and a package.tgz file generated by pkg aspect.
 
 ## capsule
 
-**Workspace only**: yes  
 **Description**: manage capsules  
 a capsule is a directory containing the component code, isolated from the workspace.  
 normally, capsules are created during the build process, the component files are copied and the packages are installed  
@@ -199,7 +209,6 @@ with no args, only workspace's capsules are deleted
 
 ## check-types
 
-**Workspace only**: yes  
 **Description**: check typescript types
 
 `bit check-types [component-pattern]`
@@ -214,7 +223,6 @@ with no args, only workspace's capsules are deleted
 ## checkout
 
 **Alias**: `U`  
-**Workspace only**: yes  
 **Description**: switch between component versions or remove local changes
 
 `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version  
@@ -243,7 +251,6 @@ with no args, only workspace's capsules are deleted
 ## clear-cache
 
 **Alias**: `cc`  
-**Workspace only**: no  
 **Description**: clears Bit's cache from current working machine  
 The following gets removed by this command:
 
@@ -261,7 +268,6 @@ The following gets removed by this command:
 
 ## cli
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. enters bit cli program and generates commands list
 
 `bit cli`
@@ -281,7 +287,6 @@ The following gets removed by this command:
 
 ## compile
 
-**Workspace only**: yes  
 **Description**: compile components in the workspace
 
 `bit compile [component-names...]`
@@ -297,7 +302,6 @@ The following gets removed by this command:
 
 ## completion
 
-**Workspace only**: yes  
 **Description**: enable bash/zsh-completion shortcuts for commands and options
 
 `bit completion`
@@ -306,7 +310,6 @@ The following gets removed by this command:
 
 ## config
 
-**Workspace only**: yes  
 **Description**: global config management  
 https://bit.dev/docs/config/bit-config
 
@@ -340,7 +343,6 @@ https://bit.dev/docs/config/bit-config
 
 ## create
 
-**Workspace only**: yes  
 **Description**: create a new component (source files and config) using a template.
 
 `bit create <template-name> <component-names...>`
@@ -357,7 +359,6 @@ https://bit.dev/docs/config/bit-config
 
 ## dependents
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. show dependents of the given component
 
 `bit dependents <component-name>`
@@ -367,7 +368,6 @@ https://bit.dev/docs/config/bit-config
 ## deprecate
 
 **Alias**: `d`  
-**Workspace only**: no  
 **Description**: deprecate a component
 
 `bit deprecate <component-name>`
@@ -381,7 +381,6 @@ https://bit.dev/docs/config/bit-config
 ## deps
 
 **Alias**: `dependencies`  
-**Workspace only**: yes  
 **Description**: manage dependencies
 
 `bit deps <sub-command>`
@@ -407,6 +406,17 @@ https://bit.dev/docs/config/bit-config
 | `--dev`    |       `-d`       | remove from devDependencies  |
 | `--peer`   |       `-p`       | remove from peerDependencies |
 
+### deps unset
+
+**Usage**: `deps unset <component-pattern> <package...>`
+
+**Description**: unset a dependency to component(s) that was previously set by "bit deps set"
+
+| **Option** | **Option alias** | **Description**             |
+| ---------- | :--------------: | --------------------------- |
+| `--dev`    |       `-d`       | unset from devDependencies  |
+| `--peer`   |       `-p`       | unset from peerDependencies |
+
 ### deps debug
 
 **Usage**: `deps debug <component-name>`
@@ -446,7 +456,6 @@ https://bit.dev/docs/config/bit-config
 
 ## diff
 
-**Workspace only**: yes  
 **Description**: show the diff between the components' source files and config  
 bit diff => compare all modified components to their model version  
  bit diff [ids...] => compare the specified components against their modified states  
@@ -465,7 +474,6 @@ bit diff => compare all modified components to their model version
 
 ## doctor
 
-**Workspace only**: yes  
 **Description**: diagnose a bit workspace
 
 `bit doctor [diagnosis-name]`
@@ -481,7 +489,6 @@ bit diff => compare all modified components to their model version
 ## eject
 
 **Alias**: `E`  
-**Workspace only**: yes  
 **Description**: replace components maintained in the workspace with their corresponding packages
 
 `bit eject <component-pattern>`
@@ -496,7 +503,6 @@ bit diff => compare all modified components to their model version
 
 ## eject-conf
 
-**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"  
@@ -515,7 +521,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 ## envs
 
 **Alias**: `env`  
-**Workspace only**: yes  
 **Description**: list all components maintained by the workspace and their corresponding envs
 
 `bit envs`
@@ -572,7 +577,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 ## export
 
 **Alias**: `e`  
-**Workspace only**: yes  
 **Description**: export components from the workspace to remote scopes  
 bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well  
  `bit export [id...]` => export the given ids to their current scope  
@@ -594,7 +598,6 @@ bit export => export all staged components to their current scope, if checked ou
 
 ## fork
 
-**Workspace only**: no  
 **Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
 
 `bit fork <source-component-id> [target-component-name]`
@@ -612,7 +615,6 @@ bit export => export all staged components to their current scope, if checked ou
 
 ## format
 
-**Workspace only**: yes  
 **Description**: format components in the development workspace
 
 `bit format [component...]`
@@ -627,7 +629,6 @@ bit export => export all staged components to their current scope, if checked ou
 
 ## globals
 
-**Workspace only**: yes  
 **Description**: list all globals
 
 `bit globals`
@@ -640,7 +641,6 @@ bit export => export all staged components to their current scope, if checked ou
 
 ## graph
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. generate an image file with the dependencies graph
 
 `bit graph [id]`
@@ -658,7 +658,6 @@ bit export => export all staged components to their current scope, if checked ou
 ## help
 
 **Alias**: `$0`  
-**Workspace only**: yes  
 **Description**: shows help
 
 `bit help`
@@ -671,7 +670,6 @@ bit export => export all staged components to their current scope, if checked ou
 
 ## import
 
-**Workspace only**: yes  
 **Description**: import components from their remote scopes to the local workspace  
 https://bit.dev/docs/components/importing-components  
 you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
@@ -699,7 +697,6 @@ you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the
 
 ## init
 
-**Workspace only**: no  
 **Description**: create or reinitialize an empty workspace  
 https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
 
@@ -726,7 +723,6 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
 ## install
 
 **Alias**: `in`  
-**Workspace only**: yes  
 **Description**: installs workspace dependencies  
 when no package is specified, all workspace dependencies are installed and all workspace components are imported.
 
@@ -742,12 +738,12 @@ when no package is specified, all workspace dependencies are installed and all w
 | `--skip-import [skipImport]`            |                  | do not import bit objects post installation                                                            |
 | `--skip-compile [skipCompile]`          |                  | do not compile components                                                                              |
 | `--add-missing-peers [addMissingPeers]` |                  | install all missing peer dependencies                                                                  |
+| `--no-optional [noOptional]`            |                  | do not install optional dependencies (works with pnpm only)                                            |
 
 ---
 
 ## link
 
-**Workspace only**: yes  
 **Description**: create links in the node_modules directory, to core aspects and to components in the workspace  
 https://bit.dev/docs/workspace/component-links
 
@@ -765,7 +761,6 @@ https://bit.dev/docs/workspace/component-links
 
 ## lint
 
-**Workspace only**: yes  
 **Description**: lint components in the development workspace
 
 `bit lint [component...]`
@@ -782,7 +777,6 @@ https://bit.dev/docs/workspace/component-links
 ## list
 
 **Alias**: `ls`  
-**Workspace only**: no  
 **Description**: list components on a workspace, local scope or a remote scope.  
 https://bit.dev/docs/reference/cli-reference#list
 
@@ -800,7 +794,6 @@ https://bit.dev/docs/reference/cli-reference#list
 
 ## log
 
-**Workspace only**: no  
 **Description**: show components(s) version history  
 https://bit.dev/docs/reference/cli-reference#log
 
@@ -817,7 +810,6 @@ https://bit.dev/docs/reference/cli-reference#log
 
 ## log-file
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. show file history
 
 `bit log-file <filepath>`
@@ -830,7 +822,6 @@ https://bit.dev/docs/reference/cli-reference#log
 
 ## login
 
-**Workspace only**: no  
 **Description**: log in to Bit cloud
 
 `bit login`
@@ -847,7 +838,6 @@ https://bit.dev/docs/reference/cli-reference#log
 
 ## logout
 
-**Workspace only**: yes  
 **Description**: log the CLI out of Bit
 
 `bit logout`
@@ -856,7 +846,6 @@ https://bit.dev/docs/reference/cli-reference#log
 
 ## merge
 
-**Workspace only**: yes  
 **Description**: merge changes of the remote head into local  
 merge changes of the remote head into local, optionally use '--abort' or '--resolve  
 you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
@@ -881,7 +870,6 @@ you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the
 ## move
 
 **Alias**: `mv`  
-**Workspace only**: yes  
 **Description**: move a component to a different filesystem path  
 move files or directories of component(s)  
  https://bit.dev/docs/workspace/moving-components
@@ -892,7 +880,6 @@ move files or directories of component(s)
 
 ## new
 
-**Workspace only**: yes  
 **Description**: create a new workspace from a template
 
 `bit new <template-name> <workspace-name>`
@@ -910,7 +897,6 @@ move files or directories of component(s)
 
 ## pattern
 
-**Workspace only**: yes  
 **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".  
@@ -930,7 +916,6 @@ the matching algorithm is done by multimatch (@see https://github.com/sindresorh
 
 ## refactor
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. source code refactoring / codemod
 
 `bit refactor <sub-command>`
@@ -946,7 +931,6 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
 
 ## remote
 
-**Workspace only**: yes  
 **Description**: manage set of tracked bit scope(s)  
 https://bit.dev/docs/scope/remote-scopes
 
@@ -983,7 +967,6 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
 ## remove
 
 **Alias**: `rm`  
-**Workspace only**: no  
 **Description**: remove component(s) from the workspace, or a remote scope
 
 `bit remove <component-pattern>`
@@ -1003,7 +986,6 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
 
 ## rename
 
-**Workspace only**: no  
 **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
 
 `bit rename <current-name> <new-name>`
@@ -1018,7 +1000,6 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
 
 ## reset
 
-**Workspace only**: yes  
 **Description**: revert tagged or snapped versions for component(s)  
 https://bit.dev/docs/components/tags#undoing-a-tag
 
@@ -1036,7 +1017,6 @@ https://bit.dev/docs/components/tags#undoing-a-tag
 ## run
 
 **Alias**: `c`  
-**Workspace only**: yes  
 **Description**: run an app (independent of bit's dev server)
 
 `bit run <app-name>`
@@ -1052,7 +1032,6 @@ https://bit.dev/docs/components/tags#undoing-a-tag
 
 ## schema
 
-**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"  
@@ -1069,7 +1048,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 ## scope
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. manage the scope-name for components
 
 `bit scope <sub-command>`
@@ -1116,7 +1094,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 ## scope-config
 
-**Workspace only**: yes  
 **Description**: scope config management
 
 `bit scope-config`
@@ -1149,7 +1126,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 ## show
 
-**Workspace only**: yes  
 **Description**: display the component's essential information
 
 `bit show <component-name>`
@@ -1165,7 +1141,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 ## snap
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. create an immutable and exportable component snapshot (no release version)  
 https://bit.dev/components/snaps  
 you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
@@ -1192,7 +1167,6 @@ you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the p
 ## start
 
 **Alias**: `c`  
-**Workspace only**: yes  
 **Description**: run the ui/development server
 
 `bit start [type] [pattern]`
@@ -1212,7 +1186,6 @@ you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the p
 ## status
 
 **Alias**: `s`  
-**Workspace only**: yes  
 **Description**: present the current status of components in the workspace, and notifies when issues are detected
 
 `bit status`
@@ -1229,7 +1202,6 @@ you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the p
 ## tag
 
 **Alias**: `t`  
-**Workspace only**: yes  
 **Description**: create an immutable and exportable component snapshot, tagged with a release version.  
 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
@@ -1269,7 +1241,6 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
 
 ## templates
 
-**Workspace only**: yes  
 **Description**: list templates for "bit create" and "bit new"  
 list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
 
@@ -1285,7 +1256,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 ## test
 
 **Alias**: `at`  
-**Workspace only**: yes  
 **Description**: test components in the workspace
 
 `bit test [component-pattern]`
@@ -1304,7 +1274,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 ## undeprecate
 
-**Workspace only**: no  
 **Description**: undeprecate a deprecated component (local/remote)
 
 `bit undeprecate <id>`
@@ -1314,7 +1283,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 ## uninstall
 
 **Alias**: `un`  
-**Workspace only**: yes  
 **Description**: uninstall dependencies
 
 `bit uninstall [packages...]`
@@ -1324,7 +1292,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 ## update
 
 **Alias**: `up`  
-**Workspace only**: yes  
 **Description**: update dependencies
 
 `bit update`
@@ -1337,7 +1304,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 ## use
 
-**Workspace only**: yes  
 **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
 
 `bit use <component-id>`
@@ -1346,7 +1312,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 ## watch
 
-**Workspace only**: yes  
 **Description**: automatically recompile modified components (on save)
 
 `bit watch`
@@ -1361,7 +1326,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 ## write-tsconfig
 
-**Workspace only**: yes  
 **Description**: EXPERIMENTAL. write tsconfig.json files in the component directories
 
 `bit write-tsconfig`

package/dist/cli-reference.json

@@ -1577,6 +1577,11 @@
                 "",
                 "add-missing-peers [addMissingPeers]",
                 "install all missing peer dependencies"
+            ],
+            [
+                "",
+                "no-optional [noOptional]",
+                "do not install optional dependencies (works with pnpm only)"
             ]
         ],
         "description": "installs workspace dependencies",
@@ -2831,7 +2836,7 @@
                     ]
                 ],
                 "description": "merge a local or a remote lane",
-                "extendedDescription": "if the <lane> exists locally, it will be merged from the local lane.\notherwise, it will fetch the lane from the remote and merge it.\nin case the <lane> exists locally but you want to merge the remote version of it, use --remote flag.\nwhen the current and the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
+                "extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
                 "private": true,
                 "remoteOp": true,
                 "arguments": [
@@ -2993,6 +2998,36 @@
                     }
                 ]
             },
+            {
+                "name": "unset <component-pattern> <package...>",
+                "alias": "",
+                "options": [
+                    [
+                        "d",
+                        "dev",
+                        "unset from devDependencies"
+                    ],
+                    [
+                        "p",
+                        "peer",
+                        "unset from peerDependencies"
+                    ]
+                ],
+                "description": "unset a dependency to component(s) that was previously set by \"bit deps set\"",
+                "extendedDescription": "",
+                "group": "info",
+                "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": "package...",
+                        "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
+                    }
+                ]
+            },
             {
                 "name": "debug <component-name>",
                 "alias": "",