@teambit/harmony.content.cli-reference 1.95.24 → 1.95.27

package/cli-reference.mdx

@@ -1,8 +1,3 @@
----
-id: cli-all
-title: CLI Commands
----
-
 # 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.
@@ -11,8 +6,8 @@ Commands that are marked as workspace only must be executed inside a workspace.
 
 **Alias**: `a`  
 **Workspace only**: yes  
-**Description**: add any subset of files to be tracked as a component(s)  
- all flags support glob patterns and {PARENT} {FILE_NAME} annotations  
+**Description**: Add any subset of files to be tracked as a component(s).  
+all flags support glob patterns and {PARENT} {FILE_NAME} annotations  
  https://bit.dev/docs/components/adding-components
 
 `bit add [path...]`
@@ -51,7 +46,7 @@ Commands that are marked as workspace only must be executed inside a workspace.
 ## artifacts
 
 **Workspace only**: yes  
-**Description**: EXPERIMENTAL. list and download components artifacts.  
+**Description**: EXPERIMENTAL. 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  
 and a package.tgz file generated by pkg aspect.
@@ -157,7 +152,7 @@ examples:
 ## capsule
 
 **Workspace only**: yes  
-**Description**: manage capsules.  
+**Description**: manage capsules  
 a capsule is a directory contains 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  
 via the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for  
@@ -196,7 +191,8 @@ other users after publishing/exporting them.
 
 **Usage**: `capsule delete`
 
-**Description**: delete capsules. with no args, only workspace's capsules are deleted
+**Description**: delete capsules  
+with no args, only workspace's capsules are deleted
 
 | **Option**        | **Option alias** | **Description**                                   |
 | ----------------- | :--------------: | ------------------------------------------------- |
@@ -223,9 +219,11 @@ other users after publishing/exporting them.
 
 **Alias**: `U`  
 **Workspace only**: yes  
-**Description**: switch between component versions or remove local changes  
- `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version  
- `bit checkout latest [ids...]` => checkout the specified ids (or all components when --all is used) to their latest versions  
+**Description**: switch between component versions or remove local changes
+
+`bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version  
+ `bit checkout latest` => checkout all components to their latest versions  
+ `bit checkout latest [ids...]` => checkout the specified ids to their latest versions  
  `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)  
  you can use a pattern for multiple ids, such as bit checkout 0.0.1 "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
 
@@ -284,6 +282,7 @@ The following gets removed by this command:
 | **Option**   | **Option alias** | **Description**                                                                                                                |
 | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
 | `--metadata` |                  | metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands |
+| `--json`     |       `-j`       | output the commands info as JSON                                                                                               |
 
 ---
 
@@ -328,8 +327,8 @@ The following gets removed by this command:
 ## config
 
 **Workspace only**: yes  
-**Description**: global config management.  
- https://bit.dev/docs/config/bit-config
+**Description**: global config management  
+https://bit.dev/docs/config/bit-config
 
 `bit config`
 
@@ -416,7 +415,7 @@ The following gets removed by this command:
 
 **Workspace only**: yes  
 **Description**: show diff between components files  
- bit diff => compare all modified components to their model version  
+bit diff => compare all modified components to their model version  
  bit diff [ids...] => compare the specified components against their modified states  
  bit diff [id] [version] => compare the specified version to used or modified files  
  bit diff [id] [version] [to_version] => compare the specified version files to to_version files  
@@ -513,9 +512,12 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 ### envs unset
 
-**Usage**: `envs unset <component>`
+**Usage**: `envs unset <pattern>`
 
-**Description**: unset an environment from component(s)  
+**Description**: unset an environment from component(s) that was set by "bit env set"  
+keep in mind that this doesn't remove envs that are set in the variants.  
+in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".  
+the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.  
 you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"  
 always wrap the pattern with quotes to avoid collision with shell commands.  
 to validate the pattern before running this command, run `bit pattern <pattern>`.
@@ -532,7 +534,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 **Alias**: `e`  
 **Workspace only**: yes  
-**Description**: export components to a remote scope.  
+**Description**: Export components to a remote scope  
 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
 
@@ -631,35 +633,35 @@ to set the default-scope, please use --scope flag
 ## import
 
 **Workspace only**: yes  
-**Description**: import components into your current workspace.  
+**Description**: import components into your 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)
 
 `bit import [ids...]`
 
-| **Option**                       | **Option alias** | **Description**                                                                                                                 |
-| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------- |
-| `--path <path>`                  |       `-p`       | import components into a specific directory                                                                                     |
-| `--objects`                      |       `-o`       | import components objects only, don't write the components to the file system. This is a default behavior for import with no id |
-| `--display-dependencies`         |       `-d`       | display the imported dependencies                                                                                               |
-| `--override`                     |       `-O`       | override local changes                                                                                                          |
-| `--verbose`                      |       `-v`       | showing verbose output for inspection                                                                                           |
-| `--json`                         |       `-j`       | return the output as JSON                                                                                                       |
-| `--conf`                         |                  | write the configuration file (component.json) of the component (harmony components only)                                        |
-| `--skip-npm-install`             |                  | DEPRECATED. use "--skip-dependency-installation" instead                                                                        |
-| `--skip-dependency-installation` |                  | do not install packages of the imported components                                                                              |
-| `--merge [strategy]`             |       `-m`       | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual"                                  |
-| `--dependencies`                 |                  | EXPERIMENTAL. import all dependencies and write them to the workspace                                                           |
-| `--dependents`                   |                  | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag                                              |
-| `--skip-lane`                    |                  | EXPERIMENTAL. when checked out to a lane, do not import the component into the lane, save it on main                            |
-| `--all-history`                  |                  | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always                           |
+| **Option**                       | **Option alias** | **Description**                                                                                                                     |
+| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `--path <path>`                  |       `-p`       | import components into a specific directory                                                                                         |
+| `--objects`                      |       `-o`       | import components objects only, don't write the components to the file system. This is a default behavior for import with no id     |
+| `--display-dependencies`         |       `-d`       | display the imported dependencies                                                                                                   |
+| `--override`                     |       `-O`       | override local changes                                                                                                              |
+| `--verbose`                      |       `-v`       | showing verbose output for inspection                                                                                               |
+| `--json`                         |       `-j`       | return the output as JSON                                                                                                           |
+| `--conf`                         |                  | write the configuration file (component.json) of the component (harmony components only)                                            |
+| `--skip-npm-install`             |                  | DEPRECATED. use "--skip-dependency-installation" instead                                                                            |
+| `--skip-dependency-installation` |                  | do not install packages of the imported components                                                                                  |
+| `--merge [strategy]`             |       `-m`       | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual"                                      |
+| `--dependencies`                 |                  | EXPERIMENTAL. import all dependencies and write them to the workspace                                                               |
+| `--dependents`                   |                  | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag                                                  |
+| `--save-in-lane`                 |                  | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
+| `--all-history`                  |                  | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always                               |
 
 ---
 
 ## init
 
 **Workspace only**: no  
-**Description**: initialize an empty bit scope  
+**Description**: create or reinitialize an empty workspace  
 https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
 
 `bit init [path]`
@@ -703,7 +705,7 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
 ## link
 
 **Workspace only**: yes  
-**Description**: generate symlinks to resolve module paths for imported components.  
+**Description**: link components and core aspects  
 https://bit.dev/docs/workspace/component-links
 
 `bit link [ids...]`
@@ -738,8 +740,8 @@ https://bit.dev/docs/workspace/component-links
 
 **Alias**: `ls`  
 **Workspace only**: no  
-**Description**: list components on a local or a remote scope.  
- https://bit.dev/docs/reference/cli-reference#list
+**Description**: list components on a workspace, local scope or a remote scope.  
+https://bit.dev/docs/reference/cli-reference#list
 
 `bit list [remote-scope]`
 
@@ -758,8 +760,8 @@ https://bit.dev/docs/workspace/component-links
 ## log
 
 **Workspace only**: no  
-**Description**: show components(s) tag history.  
- https://bit.dev/docs/reference/cli-reference#log
+**Description**: show components(s) version history  
+https://bit.dev/docs/reference/cli-reference#log
 
 `bit log <id>`
 
@@ -800,6 +802,7 @@ https://bit.dev/docs/workspace/component-links
 
 **Workspace only**: yes  
 **Description**: merge changes of different component versions  
+merge changes of different component versions  
  `bit merge <version> [ids...]` => merge changes of the given version into the checked out version  
  `bit merge [ids...]` => EXPERIMENTAL. 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 0.0.1 "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
@@ -823,7 +826,8 @@ https://bit.dev/docs/workspace/component-links
 
 **Alias**: `mv`  
 **Workspace only**: yes  
-**Description**: move files or directories of component(s)  
+**Description**: move a component to a different filesystem path  
+move files or directories of component(s)  
  https://bit.dev/docs/workspace/moving-components
 
 `bit move <existing-dir> <new-dir>`
@@ -902,7 +906,7 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
 
 **Workspace only**: yes  
 **Description**: manage set of tracked bit scope(s)  
- https://bit.dev/docs/scope/remote-scopes
+https://bit.dev/docs/scope/remote-scopes
 
 `bit remote`
 
@@ -910,9 +914,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
 
 **Usage**: `remote add <url>`
 
-**Description**: add a bare-scope as a remote. supported protocols are [file, http, ssh].  
-for example: "http://localhost:3000", "file:///tmp/local-scope", "ssh://user@127.0.0.1:/tmp/local-scope".  
-Legacy support [file, ssh]. Harmony supports [file, http].
+**Description**: add a bare-scope as a remote  
+supported protocols are [file, http].  
+for example: "http://localhost:3000", "file:///tmp/local-scope"
 
 | **Option** | **Option alias** | **Description**              |
 | ---------- | :--------------: | ---------------------------- |
@@ -938,9 +942,9 @@ Legacy support [file, ssh]. Harmony supports [file, http].
 
 **Alias**: `rm`  
 **Workspace only**: no  
-**Description**: remove a component (local/remote)  
- https://bit.dev/docs/components/removing-components  
- you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
+**Description**: remove component(s) from your workspace, or a remote scope  
+https://bit.dev/docs/components/removing-components  
+you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
 
 `bit remove <ids...>`
 
@@ -972,17 +976,6 @@ to assign a default-scope to this component, please use "--scope" flag
 
 ---
 
-## resume-export
-
-**Workspace only**: yes  
-**Description**: resume failed export to persist the pending objects on the given remotes.  
-the export-id is the id the client got in the error message during the failure.  
-alternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id
-
-`bit resume-export <export-id> <remotes...>`
-
----
-
 ## run
 
 **Alias**: `c`  
@@ -1124,8 +1117,8 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 **Alias**: `s`  
 **Workspace only**: yes  
-**Description**: show the working area component(s) status.  
- https://bit.dev/docs/workspace/workspace-status
+**Description**: show the working area component(s) status  
+https://bit.dev/docs/workspace/workspace-status
 
 `bit status`
 
@@ -1140,7 +1133,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
 
 **Alias**: `t`  
 **Workspace only**: yes  
-**Description**: record component changes and lock versions.  
+**Description**: record component changes and lock versions  
 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  
@@ -1182,7 +1175,8 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
 ## templates
 
 **Workspace only**: yes  
-**Description**: list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
+**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)
 
 `bit templates`
 
@@ -1244,9 +1238,9 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
 ## untag
 
 **Workspace only**: yes  
-**Description**: revert version(s) tagged for component(s)  
- https://bit.dev/docs/components/tags#undoing-a-tag  
- you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
+**Description**: revert versions tagged for component(s)  
+https://bit.dev/docs/components/tags#undoing-a-tag  
+you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
 
 `bit untag [id] [version]`