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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/cli-reference.json +244 -125
  2. package/cli-reference.mdx +80 -96
  3. package/dist/cli-reference.json +244 -125
  4. package/dist/cli-reference.mdx.js +91 -167
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.33.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1655263660719.js → preview-1655782086029.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.30.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -12,15 +12,15 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
12
12
 
13
13
  `bit add [path...]`
14
14
 
15
- | **Option** | **Option alias** | **Description** |
16
- | ---------------------------------- | :--------------: | ---------------------------------------------------------------------------------------- |
17
- | `--id <name>` | `-i` | manually set component id |
18
- | `--main <file>` | `-m` | define entry point for the components |
19
- | `--tests <file>/"<file>,<file>"` | `-t` | specify test files to track. use quotation marks to list files or use a glob pattern |
20
- | `--namespace <namespace>` | `-n` | organize component in a namespace |
21
- | `--exclude <file>/"<file>,<file>"` | `-e` | exclude file from being tracked. use quotation marks to list files or use a glob pattern |
22
- | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
23
- | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
15
+ | **Option** | **Option alias** | **Description** |
16
+ | ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
17
+ | `--id <name>` | `-i` | manually set component id |
18
+ | `--main <file>` | `-m` | define entry point for the components |
19
+ | `--tests <file>/"<file>,<file>"` | `-t` | LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern |
20
+ | `--namespace <namespace>` | `-n` | organize component in a namespace |
21
+ | `--exclude <file>/"<file>,<file>"` | `-e` | LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern |
22
+ | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
23
+ | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
24
24
 
25
25
  ---
26
26
 
@@ -73,10 +73,7 @@ and a package.tgz file generated by pkg aspect.
73
73
 
74
74
  **Usage**: `aspect list [pattern]`
75
75
 
76
- **Description**: list all aspects configured on component(s)
77
- 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"
78
- always wrap the pattern with quotes to avoid collision with shell commands.
79
- to validate the pattern before running this command, run `bit pattern <pattern>`.
76
+ **Description**: list all aspects configured on component(s)
80
77
 
81
78
  | **Option** | **Option alias** | **Description** |
82
79
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -84,9 +81,9 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
84
81
 
85
82
  ### aspect get
86
83
 
87
- **Usage**: `aspect get <component-id>`
84
+ **Usage**: `aspect get <component-name>`
88
85
 
89
- **Description**: show aspects' data and configuration of the given component
86
+ **Description**: list the aspects set on a component, as well as their config and data
90
87
 
91
88
  | **Option** | **Option alias** | **Description** |
92
89
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -97,35 +94,19 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
97
94
 
98
95
  **Usage**: `aspect set <pattern> <aspect-id> [config]`
99
96
 
100
- **Description**: set an aspect to component(s) with optional config.
101
- enter the config as stringified JSON (e.g. '{"foo":"bar"}' ).
102
- if no config entered, the aspect will be set with empty config ({}).
103
- you can use a `<pattern>` for multiple component ids, such as `bit aspect set "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
104
- always wrap the pattern with quotes to avoid collision with shell commands.
105
- to validate the pattern before running this command, run `bit pattern <pattern>`.
97
+ **Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
106
98
 
107
99
  ### aspect unset
108
100
 
109
101
  **Usage**: `aspect unset <pattern> <aspect-id>`
110
102
 
111
- **Description**: unset an aspect from component(s).
112
- 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"
113
- always wrap the pattern with quotes to avoid collision with shell commands.
114
- to validate the pattern before running this command, run `bit pattern <pattern>`.
103
+ **Description**: unset an aspect from component(s).
115
104
 
116
105
  ### aspect update
117
106
 
118
107
  **Usage**: `aspect update <aspect-id> [pattern]`
119
108
 
120
- **Description**: update a version of an aspect
121
- default to all components using the aspect, unless "pattern" is provided.
122
- you can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
123
- always wrap the pattern with quotes to avoid collision with shell commands.
124
- to validate the pattern before running this command, run `bit pattern <pattern>`.
125
-
126
- examples:
127
- "bit aspect update scope.org/aspect '**/ui/**'" - update "ui" components that use scope.org/aspect to the latest version
128
- "bit aspect update scope.org/aspect@2.0.0" - updates all components using scope.org/aspect to version 2.0.0.
109
+ **Description**: update a version of an aspect
129
110
 
130
111
  ---
131
112
 
@@ -134,7 +115,7 @@ examples:
134
115
  **Workspace only**: yes
135
116
  **Description**: run set of tasks for build
136
117
 
137
- `bit build [pattern]`
118
+ `bit build [component-pattern]`
138
119
 
139
120
  | **Option** | **Option alias** | **Description** |
140
121
  | ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
@@ -153,7 +134,7 @@ examples:
153
134
 
154
135
  **Workspace only**: yes
155
136
  **Description**: manage capsules
156
- a capsule is a directory contains the component code, isolated from the workspace.
137
+ a capsule is a directory containing the component code, isolated from the workspace.
157
138
  normally, capsules are created during the build process, the component files are copied and the packages are installed
158
139
  via the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for
159
140
  other users after publishing/exporting them.
@@ -164,7 +145,7 @@ other users after publishing/exporting them.
164
145
 
165
146
  **Usage**: `capsule list`
166
147
 
167
- **Description**: list all capsules
148
+ **Description**: list the capsules generated for this workspace
168
149
 
169
150
  | **Option** | **Option alias** | **Description** |
170
151
  | ---------- | :--------------: | --------------- |
@@ -172,9 +153,9 @@ other users after publishing/exporting them.
172
153
 
173
154
  ### capsule create
174
155
 
175
- **Usage**: `capsule create [componentIds...]`
156
+ **Usage**: `capsule create [component-id...]`
176
157
 
177
- **Description**: create capsules
158
+ **Description**: create capsules for components
178
159
 
179
160
  | **Option** | **Option alias** | **Description** |
180
161
  | -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
@@ -206,7 +187,7 @@ with no args, only workspace's capsules are deleted
206
187
  **Workspace only**: yes
207
188
  **Description**: check typescript types
208
189
 
209
- `bit check-types [pattern]`
190
+ `bit check-types [component-pattern]`
210
191
 
211
192
  | **Option** | **Option alias** | **Description** |
212
193
  | ---------- | :--------------: | --------------------------------------------------------- |
@@ -414,7 +395,7 @@ https://bit.dev/docs/config/bit-config
414
395
  ## diff
415
396
 
416
397
  **Workspace only**: yes
417
- **Description**: show diff between components files
398
+ **Description**: show the diff between the components' source files and config
418
399
  bit diff => compare all modified components to their model version
419
400
  bit diff [ids...] => compare the specified components against their modified states
420
401
  bit diff [id] [version] => compare the specified version to used or modified files
@@ -449,12 +430,9 @@ bit diff => compare all modified components to their model version
449
430
 
450
431
  **Alias**: `E`
451
432
  **Workspace only**: yes
452
- **Description**: replaces the components from the local scope with the corresponding packages
453
- 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"
454
- always wrap the pattern with quotes to avoid collision with shell commands.
455
- to validate the pattern before running this command, run `bit pattern <pattern>`.
433
+ **Description**: replace components maintained in the workspace with their corresponding packages
456
434
 
457
- `bit eject <pattern>`
435
+ `bit eject <component-pattern>`
458
436
 
459
437
  | **Option** | **Option alias** | **Description** |
460
438
  | -------------- | :--------------: | --------------------------------------------------------------------------------- |
@@ -468,9 +446,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
468
446
 
469
447
  **Workspace only**: yes
470
448
  **Description**: eject components configuration (create a `component.json` file)
471
- 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"
449
+ you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
450
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
472
451
  always wrap the pattern with quotes to avoid collision with shell commands.
473
- to validate the pattern before running this command, run `bit pattern <pattern>`.
452
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
474
453
 
475
454
  `bit eject-conf <pattern>`
476
455
 
@@ -515,9 +494,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
515
494
  keep in mind that this doesn't remove envs that are set in the variants.
516
495
  in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
517
496
  the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.
518
- 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"
497
+ you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
498
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
519
499
  always wrap the pattern with quotes to avoid collision with shell commands.
520
- to validate the pattern before running this command, run `bit pattern <pattern>`.
500
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
521
501
 
522
502
  ### envs replace
523
503
 
@@ -549,7 +529,7 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
549
529
  | `--rewire` | `-r` | LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope |
550
530
  | `--force` | `-f` | force changing a component remote without asking for a confirmation |
551
531
  | `--all-versions` | | export not only staged versions but all of them |
552
- | `--origin-directly` | | HARMONY ONLY. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
532
+ | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
553
533
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
554
534
  | `--ignore-missing-artifacts` | | EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote |
555
535
  | `--json` | `-j` | show output in json format |
@@ -701,10 +681,10 @@ when no package is specified, all workspace dependencies are installed and all w
701
681
  ## link
702
682
 
703
683
  **Workspace only**: yes
704
- **Description**: link components and core aspects
684
+ **Description**: create links in the node_modules directory, to core aspects and to components in the workspace
705
685
  https://bit.dev/docs/workspace/component-links
706
686
 
707
- `bit link [ids...]`
687
+ `bit link [component-names...]`
708
688
 
709
689
  | **Option** | **Option alias** | **Description** |
710
690
  | ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
@@ -745,8 +725,6 @@ https://bit.dev/docs/reference/cli-reference#list
745
725
  | ---------------------- | :--------------: | ------------------------------------------------------------------------------- |
746
726
  | `--ids` | `-i` | show only component ids unformatted |
747
727
  | `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
748
- | `--bare` | `-b` | DEPRECATED. use --raw instead |
749
- | `--raw` | `-r` | show raw output (only components ids, no styling) |
750
728
  | `--outdated` | `-o` | show latest versions from remotes |
751
729
  | `--json` | `-j` | show the output in JSON format |
752
730
  | `--namespace <string>` | `-n` | show only specified namespace by using wildcards |
@@ -772,7 +750,7 @@ https://bit.dev/docs/reference/cli-reference#log
772
750
  ## login
773
751
 
774
752
  **Workspace only**: no
775
- **Description**: log the CLI into Bit Cloud
753
+ **Description**: log in to Bit cloud
776
754
 
777
755
  `bit login`
778
756
 
@@ -782,7 +760,7 @@ https://bit.dev/docs/reference/cli-reference#log
782
760
  | `--suppress-browser-launch` | | do not open a browser for authentication |
783
761
  | `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
784
762
  | `--skip-registry-config` | | don't configure bit.cloud registry |
785
- | `--machine-name <string>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
763
+ | `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
786
764
 
787
765
  ---
788
766
 
@@ -827,11 +805,11 @@ merge changes of different component versions
827
805
  move files or directories of component(s)
828
806
  https://bit.dev/docs/workspace/moving-components
829
807
 
830
- `bit move <existing-dir> <new-dir>`
808
+ `bit move <current-component-dir> <new-component-dir>`
831
809
 
832
- | **Option** | **Option alias** | **Description** |
833
- | ------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
834
- | `--component` | `-c` | move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
810
+ | **Option** | **Option alias** | **Description** |
811
+ | ------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
812
+ | `--component` | `-c` | LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
835
813
 
836
814
  ---
837
815
 
@@ -873,7 +851,14 @@ move files or directories of component(s)
873
851
  ## pattern
874
852
 
875
853
  **Workspace only**: yes
876
- **Description**: list the component ids matching the given pattern
854
+ **Description**: list the component ids matching the given pattern
855
+ this command helps validating a pattern before using it in other commands.
856
+ a pattern can be a simple component-id or component-name. e.g. "ui/button".
857
+ a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**".
858
+ to enter multiple patterns, separate them by a comma, e.g. "ui/_, lib/_"
859
+ to exclude, use "!". e.g. "ui/**, !ui/button"
860
+ always wrap the pattern with quotes to avoid collision with shell commands.
861
+ the matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)
877
862
 
878
863
  `bit pattern <pattern>`
879
864
 
@@ -939,16 +924,16 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
939
924
 
940
925
  **Alias**: `rm`
941
926
  **Workspace only**: no
942
- **Description**: remove component(s) from your workspace, or a remote scope
927
+ **Description**: remove component(s) from the workspace, or a remote scope
943
928
  https://bit.dev/docs/components/removing-components
944
929
  you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
945
930
 
946
- `bit remove <ids...>`
931
+ `bit remove <component-ids...>`
947
932
 
948
933
  | **Option** | **Option alias** | **Description** |
949
934
  | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
950
935
  | `--remote` | `-r` | remove a component from a remote scope |
951
- | `--track` | `-t` | keep tracking component (default = false) |
936
+ | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
952
937
  | `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
953
938
  | `--keep-files` | | keep component files (just untrack the component) |
954
939
  | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
@@ -959,17 +944,15 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
959
944
  ## rename
960
945
 
961
946
  **Workspace only**: no
962
- **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the source-component
963
- the `<target-name>` should include the component-name only, without the scope-name.
964
- to assign a default-scope to this component, please use "--scope" flag
947
+ **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
965
948
 
966
- `bit rename <source-name> <target-name>`
949
+ `bit rename <current-name> <new-name>`
967
950
 
968
- | **Option** | **Option alias** | **Description** |
969
- | ------------------ | :--------------: | --------------------------------------------------------------------------------------- |
970
- | `--scope <string>` | `-s` | default scope for the newly created component |
971
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
972
- | `--refactor` | `-r` | change the source code of all components using this component with the new package-name |
951
+ | **Option** | **Option alias** | **Description** |
952
+ | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------- |
953
+ | `--scope <scope-name>` | `-s` | default scope for the newly created component |
954
+ | `--path <relative-path>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
955
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
973
956
 
974
957
  ---
975
958
 
@@ -993,9 +976,10 @@ to assign a default-scope to this component, please use "--scope" flag
993
976
 
994
977
  **Workspace only**: yes
995
978
  **Description**: shows the API schema of a certain component.
996
- 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"
979
+ you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
980
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
997
981
  always wrap the pattern with quotes to avoid collision with shell commands.
998
- to validate the pattern before running this command, run `bit pattern <pattern>`.
982
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
999
983
 
1000
984
  `bit schema <pattern>`
1001
985
 
@@ -1019,9 +1003,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1019
1003
  **Description**: Sets components with a default-scope. If no component is specified, sets the workspace with a default scope
1020
1004
  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.'
1021
1005
 
1022
- you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1006
+ you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
1007
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1023
1008
  always wrap the pattern with quotes to avoid collision with shell commands.
1024
- to validate the pattern before running this command, run `bit pattern <pattern>`.
1009
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1025
1010
 
1026
1011
  ### scope rename
1027
1012
 
@@ -1129,12 +1114,11 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1129
1114
  **Alias**: `t`
1130
1115
  **Workspace only**: yes
1131
1116
  **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1132
- if no ids are provided, it will tag all new and modified components.
1133
- 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
1134
- https://bit.dev/components/tags
1135
- you can use a pattern for multiple ids, such as bit tag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1117
+ if no patterns are provided, it will tag all new and modified components.
1118
+ 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
1119
+ https://bit.dev/components/tags
1136
1120
 
1137
- `bit tag [component-names...]`
1121
+ `bit tag [component-patterns...]`
1138
1122
 
1139
1123
  | **Option** | **Option alias** | **Description** |
1140
1124
  | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
@@ -1191,15 +1175,15 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1191
1175
 
1192
1176
  `bit test [component-pattern]`
1193
1177
 
1194
- | **Option** | **Option alias** | **Description** |
1195
- | ---------------------- | :--------------: | -------------------------------------------------------------------- |
1196
- | `--watch` | `-w` | start the tester in watch mode. |
1197
- | `--debug` | `-d` | start the tester in debug mode. |
1198
- | `--all` | `-a` | test all components, not only new and modified |
1199
- | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1200
- | `--coverage` | | show code coverage data |
1201
- | `--env <id>` | `-e` | test only the given env |
1202
- | `--scope <scope-name>` | `-s` | name of the scope to test |
1178
+ | **Option** | **Option alias** | **Description** |
1179
+ | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1180
+ | `--watch` | `-w` | start the tester in watch mode. |
1181
+ | `--debug` | `-d` | start the tester in debug mode. |
1182
+ | `--all` | `-a` | test all components, not only new and modified |
1183
+ | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1184
+ | `--coverage` | | show code coverage data |
1185
+ | `--env <id>` | `-e` | test only the given env |
1186
+ | `--scope <scope-name>` | `-s` | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
1203
1187
 
1204
1188
  ---
1205
1189
 
@@ -1235,11 +1219,11 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1235
1219
  ## untag
1236
1220
 
1237
1221
  **Workspace only**: yes
1238
- **Description**: revert versions tagged for component(s)
1222
+ **Description**: revert tagged or snapped versions for component(s)
1239
1223
  https://bit.dev/docs/components/tags#undoing-a-tag
1240
1224
  you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1241
1225
 
1242
- `bit untag [id] [version]`
1226
+ `bit untag [component-name] [component-version]`
1243
1227
 
1244
1228
  | **Option** | **Option alias** | **Description** |
1245
1229
  | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
@@ -1275,13 +1259,13 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1275
1259
  ## watch
1276
1260
 
1277
1261
  **Workspace only**: yes
1278
- **Description**: watch a set of components
1262
+ **Description**: automatically recompile modified components (on save)
1279
1263
 
1280
1264
  `bit watch`
1281
1265
 
1282
1266
  | **Option** | **Option alias** | **Description** |
1283
1267
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
1284
- | `--verbose` | `-v` | showing npm verbose output for inspection and prints stack trace |
1268
+ | `--verbose` | `-v` | show npm verbose output for inspection and print the stack trace |
1285
1269
  | `--skip-pre-compilation` | | skip the compilation step before starting to watch |
1286
1270
  | `--check-types [string]` | `-t` | EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project |
1287
1271