@teambit/harmony.content.cli-reference 1.95.65 → 1.95.68

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 (10) hide show
  1. package/cli-reference.json +1738 -1234
  2. package/cli-reference.mdx +358 -303
  3. package/dist/cli-reference.json +1738 -1234
  4. package/dist/cli-reference.mdx.js +806 -558
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.68.tgz +0 -0
  7. package/package.json +3 -3
  8. package/preview-1662521943539.js +5 -0
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.65.tgz +0 -0
  10. package/preview-1662060174180.js +0 -5
package/cli-reference.mdx CHANGED
@@ -1,8 +1,3 @@
1
- ---
2
- id: cli-all
3
- title: CLI Commands
4
- ---
5
-
6
1
  # CLI Reference
7
2
 
8
3
  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,27 +6,26 @@ Commands that are marked as workspace only must be executed inside a workspace.
11
6
 
12
7
  **Alias**: `a`
13
8
  **Workspace only**: yes
14
- **Description**: add any subset of files to be tracked as a component(s)
15
- all flags support glob patterns and {PARENT} {FILE_NAME} annotations
9
+ **Description**: Add any subset of files to be tracked as a component(s).
10
+ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
16
11
  https://bit.dev/docs/components/adding-components
17
12
 
18
13
  `bit add [path...]`
19
14
 
20
- | **Option** | **Option alias** | **Description** |
21
- | ---------------------------------- | :--------------: | ---------------------------------------------------------------------------------------- |
22
- | `--id <name>` | `-i` | manually set component id |
23
- | `--main <file>` | `-m` | define entry point for the components |
24
- | `--tests <file>/"<file>,<file>"` | `-t` | specify test files to track. use quotation marks to list files or use a glob pattern |
25
- | `--namespace <namespace>` | `-n` | organize component in a namespace |
26
- | `--exclude <file>/"<file>,<file>"` | `-e` | exclude file from being tracked. use quotation marks to list files or use a glob pattern |
27
- | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
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
+ | `--namespace <namespace>` | `-n` | organize component in a namespace |
20
+ | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
21
+ | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
28
22
 
29
23
  ---
30
24
 
31
25
  ## app
32
26
 
33
27
  **Workspace only**: yes
34
- **Description**: manage applications
28
+ **Description**: Manages apps
35
29
 
36
30
  `bit app <sub-command>`
37
31
 
@@ -39,23 +33,36 @@ Commands that are marked as workspace only must be executed inside a workspace.
39
33
 
40
34
  **Usage**: `app list`
41
35
 
42
- **Description**: list all registered applications
36
+ **Description**: list all registered apps
43
37
 
44
38
  | **Option** | **Option alias** | **Description** |
45
39
  | ---------- | :--------------: | ---------------------------------------- |
46
40
  | `--json` | `-j` | return the component data in json format |
47
41
 
42
+ ### app run
43
+
44
+ **Usage**: `app run <app-name>`
45
+
46
+ **Description**: run an app (independent of bit's dev server)
47
+
48
+ | **Option** | **Option alias** | **Description** |
49
+ | -------------- | :--------------: | -------------------------------------------------------------------------- |
50
+ | `--dev` | `-d` | start the application in dev mode. |
51
+ | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
52
+ | `--skip-watch` | | avoid running the watch process that compiles components in the background |
53
+ | `--ssr` | | run app in server side rendering mode. |
54
+
48
55
  ---
49
56
 
50
57
  ## artifacts
51
58
 
52
59
  **Workspace only**: yes
53
- **Description**: EXPERIMENTAL. list and download components artifacts.
60
+ **Description**: EXPERIMENTAL. list and download components artifacts
54
61
  artifacts are created on isolated capsules during tag or snap commands.
55
62
  example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
56
63
  and a package.tgz file generated by pkg aspect.
57
64
 
58
- `bit artifacts <pattern...>`
65
+ `bit artifacts <component-pattern>`
59
66
 
60
67
  | **Option** | **Option alias** | **Description** |
61
68
  | ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
@@ -77,10 +84,7 @@ and a package.tgz file generated by pkg aspect.
77
84
 
78
85
  **Usage**: `aspect list [pattern]`
79
86
 
80
- **Description**: list all aspects configured on component(s)
81
- 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"
82
- always wrap the pattern with quotes to avoid collision with shell commands.
83
- to validate the pattern before running this command, run `bit pattern <pattern>`.
87
+ **Description**: list all aspects configured on component(s)
84
88
 
85
89
  | **Option** | **Option alias** | **Description** |
86
90
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -88,9 +92,9 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
88
92
 
89
93
  ### aspect get
90
94
 
91
- **Usage**: `aspect get <component-id>`
95
+ **Usage**: `aspect get <component-name>`
92
96
 
93
- **Description**: show aspects' data and configuration of the given component
97
+ **Description**: list the aspects set on a component, as well as their config and data
94
98
 
95
99
  | **Option** | **Option alias** | **Description** |
96
100
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -101,35 +105,23 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
101
105
 
102
106
  **Usage**: `aspect set <pattern> <aspect-id> [config]`
103
107
 
104
- **Description**: set an aspect to component(s) with optional config.
105
- enter the config as stringified JSON (e.g. '{"foo":"bar"}' ).
106
- if no config entered, the aspect will be set with empty config ({}).
107
- 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"
108
- always wrap the pattern with quotes to avoid collision with shell commands.
109
- to validate the pattern before running this command, run `bit pattern <pattern>`.
108
+ **Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
109
+
110
+ | **Option** | **Option alias** | **Description** |
111
+ | ---------- | :--------------: | ---------------------------------------------------------------------------- |
112
+ | `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces the config) |
110
113
 
111
114
  ### aspect unset
112
115
 
113
116
  **Usage**: `aspect unset <pattern> <aspect-id>`
114
117
 
115
- **Description**: unset an aspect from component(s).
116
- 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"
117
- always wrap the pattern with quotes to avoid collision with shell commands.
118
- to validate the pattern before running this command, run `bit pattern <pattern>`.
118
+ **Description**: unset an aspect from component(s).
119
119
 
120
120
  ### aspect update
121
121
 
122
122
  **Usage**: `aspect update <aspect-id> [pattern]`
123
123
 
124
- **Description**: update a version of an aspect
125
- default to all components using the aspect, unless "pattern" is provided.
126
- 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"
127
- always wrap the pattern with quotes to avoid collision with shell commands.
128
- to validate the pattern before running this command, run `bit pattern <pattern>`.
129
-
130
- examples:
131
- "bit aspect update scope.org/aspect '**/ui/**'" - update "ui" components that use scope.org/aspect to the latest version
132
- "bit aspect update scope.org/aspect@2.0.0" - updates all components using scope.org/aspect to version 2.0.0.
124
+ **Description**: update a version of an aspect
133
125
 
134
126
  ---
135
127
 
@@ -138,7 +130,7 @@ examples:
138
130
  **Workspace only**: yes
139
131
  **Description**: run set of tasks for build
140
132
 
141
- `bit build [pattern]`
133
+ `bit build [component-pattern]`
142
134
 
143
135
  | **Option** | **Option alias** | **Description** |
144
136
  | ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
@@ -156,8 +148,8 @@ examples:
156
148
  ## capsule
157
149
 
158
150
  **Workspace only**: yes
159
- **Description**: manage capsules.
160
- a capsule is a directory contains the component code, isolated from the workspace.
151
+ **Description**: manage capsules
152
+ a capsule is a directory containing the component code, isolated from the workspace.
161
153
  normally, capsules are created during the build process, the component files are copied and the packages are installed
162
154
  via the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for
163
155
  other users after publishing/exporting them.
@@ -168,7 +160,7 @@ other users after publishing/exporting them.
168
160
 
169
161
  **Usage**: `capsule list`
170
162
 
171
- **Description**: list all capsules
163
+ **Description**: list the capsules generated for this workspace
172
164
 
173
165
  | **Option** | **Option alias** | **Description** |
174
166
  | ---------- | :--------------: | --------------- |
@@ -176,9 +168,9 @@ other users after publishing/exporting them.
176
168
 
177
169
  ### capsule create
178
170
 
179
- **Usage**: `capsule create [componentIds...]`
171
+ **Usage**: `capsule create [component-id...]`
180
172
 
181
- **Description**: create capsules
173
+ **Description**: create capsules for components
182
174
 
183
175
  | **Option** | **Option alias** | **Description** |
184
176
  | -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
@@ -195,7 +187,8 @@ other users after publishing/exporting them.
195
187
 
196
188
  **Usage**: `capsule delete`
197
189
 
198
- **Description**: delete capsules. with no args, only workspace's capsules are deleted
190
+ **Description**: delete capsules
191
+ with no args, only workspace's capsules are deleted
199
192
 
200
193
  | **Option** | **Option alias** | **Description** |
201
194
  | ----------------- | :--------------: | ------------------------------------------------- |
@@ -209,7 +202,7 @@ other users after publishing/exporting them.
209
202
  **Workspace only**: yes
210
203
  **Description**: check typescript types
211
204
 
212
- `bit check-types [pattern]`
205
+ `bit check-types [component-pattern]`
213
206
 
214
207
  | **Option** | **Option alias** | **Description** |
215
208
  | ---------- | :--------------: | --------------------------------------------------------- |
@@ -222,28 +215,26 @@ other users after publishing/exporting them.
222
215
 
223
216
  **Alias**: `U`
224
217
  **Workspace only**: yes
225
- **Description**: switch between component versions or remove local changes
226
- `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version
227
- `bit checkout latest [ids...]` => checkout the specified ids (or all components when --all is used) to their latest versions
228
- `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)
229
- 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)
230
-
231
- `bit checkout [values...]`
232
-
233
- | **Option** | **Option alias** | **Description** |
234
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
235
- | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
236
- | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
237
- | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
238
- | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
239
- | `--reset` | `-r` | remove local changes |
240
- | `--all` | `-a` | all components |
241
- | `--verbose` | `-v` | showing verbose output for inspection |
242
- | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
243
- | `--skip-dependency-installation` | | do not install packages of the imported components |
244
- | `--ignore-package-json` | | do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags) |
245
- | `--conf [path]` | | write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir) |
246
- | `--ignore-dist` | | do not write dist files (when exist) |
218
+ **Description**: switch between component versions or remove local changes
219
+
220
+ `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
221
+ `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all
222
+ `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
223
+
224
+ `bit checkout <to> [component-pattern]`
225
+
226
+ | **Option** | **Option alias** | **Description** |
227
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------- |
228
+ | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
229
+ | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
230
+ | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
231
+ | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
232
+ | `--reset` | `-r` | revert changes that were not snapped/tagged |
233
+ | `--all` | `-a` | all components |
234
+ | `--verbose` | `-v` | showing verbose output for inspection |
235
+ | `--reset` | | DEPRECATED. run "bit checkout reset" instead |
236
+ | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
237
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
247
238
 
248
239
  ---
249
240
 
@@ -283,15 +274,16 @@ The following gets removed by this command:
283
274
  | **Option** | **Option alias** | **Description** |
284
275
  | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
285
276
  | `--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 |
277
+ | `--json` | `-j` | output the commands info as JSON |
286
278
 
287
279
  ---
288
280
 
289
281
  ## compile
290
282
 
291
283
  **Workspace only**: yes
292
- **Description**: compile components in the development workspace
284
+ **Description**: compile components in the workspace
293
285
 
294
- `bit compile [component...]`
286
+ `bit compile [component-names...]`
295
287
 
296
288
  | **Option** | **Option alias** | **Description** |
297
289
  | ------------------- | :--------------: | ------------------------------------------------------------- |
@@ -327,8 +319,8 @@ The following gets removed by this command:
327
319
  ## config
328
320
 
329
321
  **Workspace only**: yes
330
- **Description**: global config management.
331
- https://bit.dev/docs/config/bit-config
322
+ **Description**: global config management
323
+ https://bit.dev/docs/config/bit-config
332
324
 
333
325
  `bit config`
334
326
 
@@ -361,9 +353,9 @@ The following gets removed by this command:
361
353
  ## create
362
354
 
363
355
  **Workspace only**: yes
364
- **Description**: create a new component from a template
356
+ **Description**: create a new component (source files and config) using a template.
365
357
 
366
- `bit create <templateName> <componentNames...>`
358
+ `bit create <template-name> <component-names...>`
367
359
 
368
360
  | **Option** | **Option alias** | **Description** |
369
361
  | ---------------------- | :--------------: | ----------------------------------------------------------------------------------- |
@@ -377,14 +369,44 @@ The following gets removed by this command:
377
369
 
378
370
  ## dependencies
379
371
 
372
+ **Alias**: `deps`
380
373
  **Workspace only**: yes
381
- **Description**: EXPERIMENTAL. show dependencies (direct and indirect) of the given component
374
+ **Description**: manage dependencies
375
+
376
+ `bit dependencies <sub-command>`
377
+
378
+ ### dependencies get
379
+
380
+ **Usage**: `dependencies get <component-name>`
381
+
382
+ **Description**: show direct and indirect dependencies of the given component
383
+
384
+ | **Option** | **Option alias** | **Description** |
385
+ | ---------- | :--------------: | ---------------------------------------------------------------- |
386
+ | `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
387
+
388
+ ### dependencies remove
382
389
 
383
- `bit dependencies <id>`
390
+ **Usage**: `dependencies remove <component-pattern> <package...>`
384
391
 
385
- | **Option** | **Option alias** | **Description** |
386
- | ---------- | :--------------: | -------------------------------------------------------------------- |
387
- | `--debug` | `-d` | show the immediate dependencies and how their version was determined |
392
+ **Description**: remove a dependency to component(s)
393
+
394
+ ### dependencies debug
395
+
396
+ **Usage**: `dependencies debug <component-name>`
397
+
398
+ **Description**: show the immediate dependencies and how their versions were determined
399
+
400
+ ### dependencies set
401
+
402
+ **Usage**: `dependencies set <component-pattern> <package...>`
403
+
404
+ **Description**: set a dependency to component(s)
405
+
406
+ | **Option** | **Option alias** | **Description** |
407
+ | ---------- | :--------------: | --------------------------- |
408
+ | `--dev` | `-d` | add to the devDependencies |
409
+ | `--peer` | `-p` | add to the peerDependencies |
388
410
 
389
411
  ---
390
412
 
@@ -393,7 +415,7 @@ The following gets removed by this command:
393
415
  **Workspace only**: yes
394
416
  **Description**: EXPERIMENTAL. show dependents of the given component
395
417
 
396
- `bit dependents <id>`
418
+ `bit dependents <component-name>`
397
419
 
398
420
  ---
399
421
 
@@ -403,7 +425,7 @@ The following gets removed by this command:
403
425
  **Workspace only**: no
404
426
  **Description**: deprecate a component
405
427
 
406
- `bit deprecate <id>`
428
+ `bit deprecate <component-name>`
407
429
 
408
430
  | **Option** | **Option alias** | **Description** |
409
431
  | ------------------- | :--------------: | ------------------------------------------------------------ |
@@ -414,8 +436,8 @@ The following gets removed by this command:
414
436
  ## diff
415
437
 
416
438
  **Workspace only**: yes
417
- **Description**: show diff between components files
418
- bit diff => compare all modified components to their model version
439
+ **Description**: show the diff between the components' source files and config
440
+ bit diff => compare all modified components to their model version
419
441
  bit diff [ids...] => compare the specified components against their modified states
420
442
  bit diff [id] [version] => compare the specified version to used or modified files
421
443
  bit diff [id] [version] [to_version] => compare the specified version files to to_version files
@@ -449,12 +471,9 @@ The following gets removed by this command:
449
471
 
450
472
  **Alias**: `E`
451
473
  **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>`.
474
+ **Description**: replace components maintained in the workspace with their corresponding packages
456
475
 
457
- `bit eject <pattern>`
476
+ `bit eject <component-pattern>`
458
477
 
459
478
  | **Option** | **Option alias** | **Description** |
460
479
  | -------------- | :--------------: | --------------------------------------------------------------------------------- |
@@ -468,9 +487,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
468
487
 
469
488
  **Workspace only**: yes
470
489
  **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"
490
+ you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
491
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
472
492
  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>`.
493
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
474
494
 
475
495
  `bit eject-conf <pattern>`
476
496
 
@@ -485,7 +505,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
485
505
 
486
506
  **Alias**: `env`
487
507
  **Workspace only**: yes
488
- **Description**: list all components envs
508
+ **Description**: list all components maintained by the workspace and their corresponding envs
489
509
 
490
510
  `bit envs`
491
511
 
@@ -497,31 +517,32 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
497
517
 
498
518
  ### envs get
499
519
 
500
- **Usage**: `envs get <name>`
520
+ **Usage**: `envs get <component-name>`
501
521
 
502
- **Description**: show component's env details
522
+ **Description**: show information about a component's env
503
523
 
504
524
  ### envs set
505
525
 
506
- **Usage**: `envs set <pattern> <env>`
526
+ **Usage**: `envs set <component-pattern> <env>`
507
527
 
508
- **Description**: set an environment for component(s)
509
- you can use a `<pattern>` for multiple component ids, such as `bit env set "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
510
- always wrap the pattern with quotes to avoid collision with shell commands.
511
- to validate the pattern before running this command, run `bit pattern <pattern>`.
528
+ **Description**: Sets one or more components with a development environment (env)
512
529
 
513
530
  ### envs unset
514
531
 
515
- **Usage**: `envs unset <component>`
532
+ **Usage**: `envs unset <component-pattern>`
516
533
 
517
- **Description**: unset an environment from component(s)
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"
534
+ **Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
535
+ keep in mind that this doesn't remove envs that are set in the variants.
536
+ in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
537
+ the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.
538
+ you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
539
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
519
540
  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>`.
541
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
521
542
 
522
543
  ### envs replace
523
544
 
524
- **Usage**: `envs replace <old-env> <new-env>`
545
+ **Usage**: `envs replace <current-env> <new-env>`
525
546
 
526
547
  **Description**: replace an existing env with another env for all components using the old env
527
548
 
@@ -531,44 +552,38 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
531
552
 
532
553
  **Alias**: `e`
533
554
  **Workspace only**: yes
534
- **Description**: export components to a remote scope.
555
+ **Description**: export components from the workspace to remote scopes
535
556
  bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well
536
- `bit export [id...]` => export the given ids to their current scope
557
+ `bit export [id...]` => export the given ids to their current scope
558
+ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
537
559
 
538
- https://bit.dev/docs/components/exporting-components
539
- you can use a pattern for multiple ids, such as bit export remote-scope "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
540
-
541
- `bit export [remote] [id...]`
560
+ `bit export [component-patterns...]`
542
561
 
543
562
  | **Option** | **Option alias** | **Description** |
544
563
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
545
- | `--eject` | `-e` | replaces the exported components from the local scope with the corresponding packages |
546
- | `--all` | `-a` | export all components include non-staged |
547
- | `--include-dependencies` | `-d` | LEGACY ONLY. include the component's dependencies as part of the export to the remote scope |
548
- | `--set-current-scope` | `-s` | LEGACY ONLY. ensure the component's remote scope is set according to the target location |
549
- | `--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
- | `--force` | `-f` | force changing a component remote without asking for a confirmation |
551
- | `--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! |
564
+ | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
565
+ | `--all` | `-a` | export all components, including non-staged (useful when components in the remote scope are corrupted or missing) |
566
+ | `--all-versions` | | export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing) |
567
+ | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
553
568
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
554
569
  | `--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 |
570
+ | `--json` | `-j` | show output in json format |
555
571
 
556
572
  ---
557
573
 
558
574
  ## fork
559
575
 
560
576
  **Workspace only**: no
561
- **Description**: EXPERIMENTAL. create a new component out of an existing one
562
- note that [target-name] is the name only without the scope.
563
- to set the default-scope, please use --scope flag
577
+ **Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
564
578
 
565
- `bit fork <source-id> [target-name]`
579
+ `bit fork <source-component-id> [target-component-name]`
566
580
 
567
- | **Option** | **Option alias** | **Description** |
568
- | ------------------ | :--------------: | ----------------------------------------------------------------------------------------------- |
569
- | `--scope <string>` | `-s` | default scope for the newly created component |
570
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
571
- | `--refactor` | `-r` | change the source code of all components using the original component with the new package-name |
581
+ | **Option** | **Option alias** | **Description** |
582
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------- |
583
+ | `--scope <string>` | `-s` | default scope for the new component |
584
+ | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
585
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
586
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
572
587
 
573
588
  ---
574
589
 
@@ -629,35 +644,35 @@ to set the default-scope, please use --scope flag
629
644
  ## import
630
645
 
631
646
  **Workspace only**: yes
632
- **Description**: import components into your current workspace.
647
+ **Description**: import components from their remote scopes to the local workspace
633
648
  https://bit.dev/docs/components/importing-components
634
649
  you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
635
650
 
636
- `bit import [ids...]`
651
+ `bit import [component-patterns...]`
637
652
 
638
- | **Option** | **Option alias** | **Description** |
639
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------- |
640
- | `--path <path>` | `-p` | import components into a specific directory |
641
- | `--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 |
642
- | `--display-dependencies` | `-d` | display the imported dependencies |
643
- | `--override` | `-O` | override local changes |
644
- | `--verbose` | `-v` | showing verbose output for inspection |
645
- | `--json` | `-j` | return the output as JSON |
646
- | `--conf` | | write the configuration file (component.json) of the component (harmony components only) |
647
- | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
648
- | `--skip-dependency-installation` | | do not install packages of the imported components |
649
- | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
650
- | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
651
- | `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
652
- | `--skip-lane` | | EXPERIMENTAL. when checked out to a lane, do not import the component into the lane, save it on main |
653
- | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
653
+ | **Option** | **Option alias** | **Description** |
654
+ | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
655
+ | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
656
+ | `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument |
657
+ | `--display-dependencies` | `-d` | display the imported dependencies |
658
+ | `--override` | `-O` | override local changes |
659
+ | `--verbose` | `-v` | show verbose output for inspection |
660
+ | `--json` | `-j` | return the output as JSON |
661
+ | `--conf` | | write the configuration file (component.json) of the component |
662
+ | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
663
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
664
+ | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
665
+ | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
666
+ | `--dependents` | | EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents |
667
+ | `--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) |
668
+ | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
654
669
 
655
670
  ---
656
671
 
657
672
  ## init
658
673
 
659
674
  **Workspace only**: no
660
- **Description**: initialize an empty bit scope
675
+ **Description**: create or reinitialize an empty workspace
661
676
  https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
662
677
 
663
678
  `bit init [path]`
@@ -670,7 +685,9 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
670
685
  | `--reset` | `-r` | write missing or damaged Bit files |
671
686
  | `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
672
687
  | `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-start using Bit from scratch |
688
+ | `--reset-scope` | | removes local scope (.bit or .git/bit). snaps that were not exported will be lost. workspace left intact |
673
689
  | `--default-directory <default-directory>` | `-d` | set up default directory to import components into |
690
+ | `--default-scope <default-scope>` | | set up default scope for all components in the workspace |
674
691
  | `--package-manager <package-manager>` | `-p` | set up package manager (npm or yarn) |
675
692
  | `--force` | `-f` | force workspace initialization without clearing local objects |
676
693
  | `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
@@ -682,7 +699,8 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
682
699
 
683
700
  **Alias**: `in`
684
701
  **Workspace only**: yes
685
- **Description**: install development workspace dependencies
702
+ **Description**: installs workspace dependencies
703
+ when no package is specified, all workspace dependencies are installed and all workspace components are imported.
686
704
 
687
705
  `bit install [packages...]`
688
706
 
@@ -701,10 +719,10 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
701
719
  ## link
702
720
 
703
721
  **Workspace only**: yes
704
- **Description**: generate symlinks to resolve module paths for imported components.
722
+ **Description**: create links in the node_modules directory, to core aspects and to components in the workspace
705
723
  https://bit.dev/docs/workspace/component-links
706
724
 
707
- `bit link [ids...]`
725
+ `bit link [component-names...]`
708
726
 
709
727
  | **Option** | **Option alias** | **Description** |
710
728
  | ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
@@ -736,8 +754,8 @@ https://bit.dev/docs/workspace/component-links
736
754
 
737
755
  **Alias**: `ls`
738
756
  **Workspace only**: no
739
- **Description**: list components on a local or a remote scope.
740
- https://bit.dev/docs/reference/cli-reference#list
757
+ **Description**: list components on a workspace, local scope or a remote scope.
758
+ https://bit.dev/docs/reference/cli-reference#list
741
759
 
742
760
  `bit list [remote-scope]`
743
761
 
@@ -745,8 +763,6 @@ https://bit.dev/docs/workspace/component-links
745
763
  | ---------------------- | :--------------: | ------------------------------------------------------------------------------- |
746
764
  | `--ids` | `-i` | show only component ids unformatted |
747
765
  | `--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
766
  | `--outdated` | `-o` | show latest versions from remotes |
751
767
  | `--json` | `-j` | show the output in JSON format |
752
768
  | `--namespace <string>` | `-n` | show only specified namespace by using wildcards |
@@ -756,8 +772,8 @@ https://bit.dev/docs/workspace/component-links
756
772
  ## log
757
773
 
758
774
  **Workspace only**: no
759
- **Description**: show components(s) tag history.
760
- https://bit.dev/docs/reference/cli-reference#log
775
+ **Description**: show components(s) version history
776
+ https://bit.dev/docs/reference/cli-reference#log
761
777
 
762
778
  `bit log <id>`
763
779
 
@@ -765,13 +781,14 @@ https://bit.dev/docs/workspace/component-links
765
781
  | ----------- | :--------------: | ----------------------------------------- |
766
782
  | `--remote` | `-r` | show log of a remote component |
767
783
  | `--parents` | | EXPERIMENTAL. show parents and lanes data |
784
+ | `--json` | `-j` | json format |
768
785
 
769
786
  ---
770
787
 
771
788
  ## login
772
789
 
773
790
  **Workspace only**: no
774
- **Description**: log the CLI into Bit Cloud
791
+ **Description**: log in to Bit cloud
775
792
 
776
793
  `bit login`
777
794
 
@@ -781,7 +798,7 @@ https://bit.dev/docs/workspace/component-links
781
798
  | `--suppress-browser-launch` | | do not open a browser for authentication |
782
799
  | `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
783
800
  | `--skip-registry-config` | | don't configure bit.cloud registry |
784
- | `--machine-name <string>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
801
+ | `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
785
802
 
786
803
  ---
787
804
 
@@ -798,22 +815,25 @@ https://bit.dev/docs/workspace/component-links
798
815
 
799
816
  **Workspace only**: yes
800
817
  **Description**: merge changes of different component versions
818
+ merge changes of different component versions
801
819
  `bit merge <version> [ids...]` => merge changes of the given version into the checked out version
802
820
  `bit merge [ids...]` => EXPERIMENTAL. merge changes of the remote head into local, optionally use '--abort' or '--resolve'
803
821
  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)
804
822
 
805
823
  `bit merge [values...]`
806
824
 
807
- | **Option** | **Option alias** | **Description** |
808
- | --------------------- | :--------------: | ------------------------------------------------------------------------------------------- |
809
- | `--ours` | | in case of a conflict, override the used version with the current modification |
810
- | `--theirs` | | in case of a conflict, override the current modification with the specified version |
811
- | `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
812
- | `--abort` | | EXPERIMENTAL. in case of an unresolved merge, revert to the state before the merge began |
813
- | `--resolve` | | EXPERIMENTAL. mark an unresolved merge as resolved and create a new snap with the changes |
814
- | `--no-snap` | | EXPERIMENTAL. do not auto snap in case the merge completed without conflicts |
815
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
816
- | `--message <message>` | `-m` | EXPERIMENTAL. override the default message for the auto snap |
825
+ | **Option** | **Option alias** | **Description** |
826
+ | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------- |
827
+ | `--ours` | | in case of a conflict, override the used version with the current modification |
828
+ | `--theirs` | | in case of a conflict, override the current modification with the specified version |
829
+ | `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
830
+ | `--abort` | | EXPERIMENTAL. in case of an unresolved merge, revert to the state before the merge began |
831
+ | `--resolve` | | EXPERIMENTAL. mark an unresolved merge as resolved and create a new snap with the changes |
832
+ | `--no-snap` | | EXPERIMENTAL. do not auto snap in case the merge completed without conflicts |
833
+ | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
834
+ | `--verbose` | | show details of components that were not merged legitimately |
835
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
836
+ | `--message <message>` | `-m` | EXPERIMENTAL. override the default message for the auto snap |
817
837
 
818
838
  ---
819
839
 
@@ -821,32 +841,29 @@ https://bit.dev/docs/workspace/component-links
821
841
 
822
842
  **Alias**: `mv`
823
843
  **Workspace only**: yes
824
- **Description**: move files or directories of component(s)
844
+ **Description**: move a component to a different filesystem path
845
+ move files or directories of component(s)
825
846
  https://bit.dev/docs/workspace/moving-components
826
847
 
827
- `bit move <existing-dir> <new-dir>`
828
-
829
- | **Option** | **Option alias** | **Description** |
830
- | ------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
831
- | `--component` | `-c` | move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
848
+ `bit move <current-component-dir> <new-component-dir>`
832
849
 
833
850
  ---
834
851
 
835
852
  ## new
836
853
 
837
854
  **Workspace only**: yes
838
- **Description**: Create a new workspace from a template
855
+ **Description**: create a new workspace from a template
839
856
 
840
- `bit new <templateName> <workspaceName>`
857
+ `bit new <template-name> <workspace-name>`
841
858
 
842
- | **Option** | **Option alias** | **Description** |
843
- | -------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
844
- | `--aspect <string>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
845
- | `--default-scope <string>` | `-d` | set defaultScope in the new workspace.jsonc |
846
- | `--standalone` | | DEPRECATED. use --skip-git instead |
847
- | `--skip-git` | `-s` | skip generation of Git repository |
848
- | `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
849
- | `--load-from <string>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
859
+ | **Option** | **Option alias** | **Description** |
860
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
861
+ | `--aspect <aspect-id>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
862
+ | `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace.jsonc |
863
+ | `--standalone` | | DEPRECATED. use --skip-git instead |
864
+ | `--skip-git` | `-s` | skip generation of Git repository |
865
+ | `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
866
+ | `--load-from <path-to-template>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
850
867
 
851
868
  ---
852
869
 
@@ -870,7 +887,14 @@ https://bit.dev/docs/workspace/component-links
870
887
  ## pattern
871
888
 
872
889
  **Workspace only**: yes
873
- **Description**: list the component ids matching the given pattern
890
+ **Description**: list the component ids matching the given pattern
891
+ this command helps validating a pattern before using it in other commands.
892
+ a pattern can be a simple component-id or component-name. e.g. "ui/button".
893
+ a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**".
894
+ to enter multiple patterns, separate them by a comma, e.g. "ui/_, lib/_"
895
+ to exclude, use "!". e.g. "ui/**, !ui/button"
896
+ always wrap the pattern with quotes to avoid collision with shell commands.
897
+ the matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)
874
898
 
875
899
  `bit pattern <pattern>`
876
900
 
@@ -900,7 +924,7 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
900
924
 
901
925
  **Workspace only**: yes
902
926
  **Description**: manage set of tracked bit scope(s)
903
- https://bit.dev/docs/scope/remote-scopes
927
+ https://bit.dev/docs/scope/remote-scopes
904
928
 
905
929
  `bit remote`
906
930
 
@@ -908,9 +932,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
908
932
 
909
933
  **Usage**: `remote add <url>`
910
934
 
911
- **Description**: add a bare-scope as a remote. supported protocols are [file, http, ssh].
912
- for example: "http://localhost:3000", "file:///tmp/local-scope", "ssh://user@127.0.0.1:/tmp/local-scope".
913
- Legacy support [file, ssh]. Harmony supports [file, http].
935
+ **Description**: add a bare-scope as a remote
936
+ supported protocols are [file, http].
937
+ for example: "http://localhost:3000", "file:///tmp/local-scope"
914
938
 
915
939
  | **Option** | **Option alias** | **Description** |
916
940
  | ---------- | :--------------: | ---------------------------- |
@@ -936,17 +960,17 @@ Legacy support [file, ssh]. Harmony supports [file, http].
936
960
 
937
961
  **Alias**: `rm`
938
962
  **Workspace only**: no
939
- **Description**: remove a component (local/remote)
940
- https://bit.dev/docs/components/removing-components
941
- you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
963
+ **Description**: remove component(s) from the workspace, or a remote scope
942
964
 
943
- `bit remove <ids...>`
965
+ `bit remove <component-pattern>`
944
966
 
945
967
  | **Option** | **Option alias** | **Description** |
946
968
  | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
947
- | `--remote` | `-r` | remove a component from a remote scope |
948
- | `--track` | `-t` | keep tracking component (default = false) |
949
- | `--delete-files` | `-d` | delete local component files (authored components only. for imported components the files are always deleted) |
969
+ | `--soft` | | EXPERIMENTAL. mark the component as deleted. after tag/snap and export the remote will be updated |
970
+ | `--remote` | `-r` | remove a component completely from a remote scope (Careful! this is a permanent change. prefer --soft and tag+export) |
971
+ | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
972
+ | `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
973
+ | `--keep-files` | | keep component files (just untrack the component) |
950
974
  | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
951
975
  | `--silent` | `-s` | skip confirmation |
952
976
 
@@ -955,28 +979,32 @@ Legacy support [file, ssh]. Harmony supports [file, http].
955
979
  ## rename
956
980
 
957
981
  **Workspace only**: no
958
- **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the source-component
959
- the `<target-name>` should include the component-name only, without the scope-name.
960
- to assign a default-scope to this component, please use "--scope" flag
982
+ **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
961
983
 
962
- `bit rename <source-name> <target-name>`
984
+ `bit rename <current-name> <new-name>`
963
985
 
964
- | **Option** | **Option alias** | **Description** |
965
- | ------------------ | :--------------: | --------------------------------------------------------------------------------------- |
966
- | `--scope <string>` | `-s` | default scope for the newly created component |
967
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
968
- | `--refactor` | `-r` | change the source code of all components using this component with the new package-name |
986
+ | **Option** | **Option alias** | **Description** |
987
+ | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------- |
988
+ | `--scope <scope-name>` | `-s` | default scope for the newly created component |
989
+ | `--path <relative-path>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
990
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
969
991
 
970
992
  ---
971
993
 
972
- ## resume-export
994
+ ## reset
973
995
 
974
996
  **Workspace only**: yes
975
- **Description**: resume failed export to persist the pending objects on the given remotes.
976
- the export-id is the id the client got in the error message during the failure.
977
- alternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id
997
+ **Description**: revert tagged or snapped versions for component(s)
998
+ https://bit.dev/docs/components/tags#undoing-a-tag
978
999
 
979
- `bit resume-export <export-id> <remotes...>`
1000
+ `bit reset [component-pattern]`
1001
+
1002
+ | **Option** | **Option alias** | **Description** |
1003
+ | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
1004
+ | `--all` | `-a` | revert tag/snap for all tagged/snapped components |
1005
+ | `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted) |
1006
+ | `--soft` | | revert only soft-tags (components tagged with --soft flag) |
1007
+ | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
980
1008
 
981
1009
  ---
982
1010
 
@@ -984,24 +1012,29 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
984
1012
 
985
1013
  **Alias**: `c`
986
1014
  **Workspace only**: yes
987
- **Description**: run an application
1015
+ **Description**: run an app (independent of bit's dev server)
988
1016
 
989
- `bit run <app>`
1017
+ `bit run <app-name>`
990
1018
 
991
1019
  | **Option** | **Option alias** | **Description** |
992
1020
  | -------------- | :--------------: | -------------------------------------------------------------------------- |
993
1021
  | `--dev` | `-d` | start the application in dev mode. |
994
1022
  | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
995
1023
  | `--skip-watch` | | avoid running the watch process that compiles components in the background |
1024
+ | `--ssr` | | run app in server side rendering mode. |
996
1025
 
997
1026
  ---
998
1027
 
999
1028
  ## schema
1000
1029
 
1001
1030
  **Workspace only**: yes
1002
- **Description**: shows the API schema of a certain component.
1031
+ **Description**: shows the API schema of a certain component.
1032
+ you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
1033
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1034
+ always wrap the pattern with quotes to avoid collision with shell commands.
1035
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1003
1036
 
1004
- `bit schema <id>`
1037
+ `bit schema <pattern>`
1005
1038
 
1006
1039
  | **Option** | **Option alias** | **Description** |
1007
1040
  | ---------- | :--------------: | ---------------------------------------- |
@@ -1009,6 +1042,43 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1009
1042
 
1010
1043
  ---
1011
1044
 
1045
+ ## scope
1046
+
1047
+ **Workspace only**: yes
1048
+ **Description**: EXPERIMENTAL. manage the scope-name for components
1049
+
1050
+ `bit scope <sub-command>`
1051
+
1052
+ ### scope set
1053
+
1054
+ **Usage**: `scope set <scope-name> [component-pattern]`
1055
+
1056
+ **Description**: Sets components with a default-scope. If no component is specified, sets the workspace with a default scope
1057
+ 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.'
1058
+
1059
+ you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
1060
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1061
+ always wrap the pattern with quotes to avoid collision with shell commands.
1062
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1063
+
1064
+ ### scope rename
1065
+
1066
+ **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1067
+
1068
+ **Description**: Renames the scope name for all components with the specified 'current scope name'
1069
+
1070
+ | **Option** | **Option alias** | **Description** |
1071
+ | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
1072
+ | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new scope name) |
1073
+
1074
+ ### scope fork
1075
+
1076
+ **Usage**: `scope fork <original-scope> <new-scope>`
1077
+
1078
+ **Description**: fork all components of the original-scope and refactor the source-code to use the new package names
1079
+
1080
+ ---
1081
+
1012
1082
  ## scope-config
1013
1083
 
1014
1084
  **Workspace only**: yes
@@ -1045,16 +1115,16 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1045
1115
  ## show
1046
1116
 
1047
1117
  **Workspace only**: yes
1048
- **Description**: show a component
1118
+ **Description**: display the component's essential information
1049
1119
 
1050
- `bit show <id>`
1120
+ `bit show <component-name>`
1051
1121
 
1052
- | **Option** | **Option alias** | **Description** |
1053
- | ----------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
1054
- | `--json` | `-j` | return the component data in json format |
1055
- | `--legacy` | `-l` | use the legacy bit show. |
1056
- | `--remote` | `-r` | show a remote component |
1057
- | `--compare` | `-c` | compare current file system component to latest tagged component [default=latest]. only works in legacy. |
1122
+ | **Option** | **Option alias** | **Description** |
1123
+ | ----------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
1124
+ | `--json` | `-j` | return the component data in a json format |
1125
+ | `--legacy` | `-l` | use the legacy bit show. |
1126
+ | `--remote` | `-r` | show a remote component |
1127
+ | `--compare` | `-c` | compare current file system component to the latest tagged component [default=latest]. only works in legacy. |
1058
1128
 
1059
1129
  ---
1060
1130
 
@@ -1062,18 +1132,18 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1062
1132
 
1063
1133
  **Alias**: `c`
1064
1134
  **Workspace only**: yes
1065
- **Description**: Start a dev environment for a workspace or a specific component
1135
+ **Description**: run the ui/development server
1066
1136
 
1067
1137
  `bit start [type] [pattern]`
1068
1138
 
1069
- | **Option** | **Option alias** | **Description** |
1070
- | -------------------- | :--------------: | ------------------------------------------------------------ |
1071
- | `--dev` | `-d` | start UI server in dev mode. |
1072
- | `--port [number]` | `-p` | port of the UI server. |
1073
- | `--rebuild` | `-r` | rebuild the UI |
1074
- | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
1075
- | `--no-browser` | | do not automatically open browser when ready |
1076
- | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1139
+ | **Option** | **Option alias** | **Description** |
1140
+ | ---------------------- | :--------------: | --------------------------------------------------------- |
1141
+ | `--dev` | `-d` | start UI server in dev mode. |
1142
+ | `--port [port-number]` | `-p` | port of the UI server. |
1143
+ | `--rebuild` | `-r` | rebuild the UI |
1144
+ | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1145
+ | `--no-browser` | | do not automatically open browser when ready |
1146
+ | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1077
1147
 
1078
1148
  ---
1079
1149
 
@@ -1081,15 +1151,15 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1081
1151
 
1082
1152
  **Alias**: `s`
1083
1153
  **Workspace only**: yes
1084
- **Description**: show the working area component(s) status.
1085
- https://bit.dev/docs/workspace/workspace-status
1154
+ **Description**: present the current status of components in the workspace, and notifies when issues are detected
1086
1155
 
1087
1156
  `bit status`
1088
1157
 
1089
- | **Option** | **Option alias** | **Description** |
1090
- | ---------- | :--------------: | -------------------------------------- |
1091
- | `--json` | `-j` | return a json version of the component |
1092
- | `--strict` | | in case issues found, exit with code 1 |
1158
+ | **Option** | **Option alias** | **Description** |
1159
+ | ----------- | :--------------: | -------------------------------------- |
1160
+ | `--json` | `-j` | return a json version of the component |
1161
+ | `--verbose` | | show full snap hashes |
1162
+ | `--strict` | | in case issues found, exit with code 1 |
1093
1163
 
1094
1164
  ---
1095
1165
 
@@ -1097,35 +1167,36 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1097
1167
 
1098
1168
  **Alias**: `t`
1099
1169
  **Workspace only**: yes
1100
- **Description**: record component changes and lock versions.
1101
- if no ids are provided, it will tag all new and modified components.
1102
- 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
1103
- https://bit.dev/components/tags
1104
- you can use a pattern for multiple ids, such as bit tag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1105
-
1106
- `bit tag [id...]`
1107
-
1108
- | **Option** | **Option alias** | **Description** |
1109
- | ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
1110
- | `--message <message>` | `-m` | log message describing the user changes |
1111
- | `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
1112
- | `--editor [editor]` | | EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim |
1113
- | `--ver <version>` | `-v` | tag with the given version |
1114
- | `--patch` | `-p` | increment the patch version number |
1115
- | `--minor` | | increment the minor version number |
1116
- | `--major` | | increment the major version number |
1117
- | `--snapped` | | tag components that their head is a snap (not a tag) |
1118
- | `--pre-release [identifier]` | | EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1) |
1119
- | `--skip-tests` | | skip running component tests during tag process |
1120
- | `--skip-auto-tag` | | skip auto tagging dependents |
1121
- | `--soft` | | do not persist. only keep note of the changes to be made |
1122
- | `--persist` | | persist the changes generated by --soft tag |
1123
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1124
- | `--force-deploy` | | run the tag pipeline although the build failed |
1125
- | `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
1126
- | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1127
-
1128
- [MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
1170
+ **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1171
+ if no patterns are provided, it will tag all new and modified components.
1172
+ 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
1173
+
1174
+ `bit tag [component-patterns...]`
1175
+
1176
+ | **Option** | **Option alias** | **Description** |
1177
+ | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
1178
+ | `--message <message>` | `-m` | a log message describing latest changes |
1179
+ | `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
1180
+ | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1181
+ | `--ver <version>` | `-v` | tag with the given version |
1182
+ | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1183
+ | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1184
+ | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1185
+ | `--minor` | | syntactic sugar for "--increment minor" |
1186
+ | `--major` | | syntactic sugar for "--increment major" |
1187
+ | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1188
+ | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1189
+ | `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
1190
+ | `--skip-tests` | | skip running component tests during tag process |
1191
+ | `--skip-auto-tag` | | skip auto tagging dependents |
1192
+ | `--soft` | | do not persist. only keep note of the changes to be made |
1193
+ | `--persist` | | persist the changes generated by --soft tag |
1194
+ | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1195
+ | `--force-deploy` | | run the tag pipeline although the build failed |
1196
+ | `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
1197
+ | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1198
+
1199
+ [MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
1129
1200
  to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
1130
1201
  |`--ignore-newest-version`|`-I`|ignore existing of newer versions (default = false)|
1131
1202
  |`--build`|`-b`|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|
@@ -1139,7 +1210,8 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
1139
1210
  ## templates
1140
1211
 
1141
1212
  **Workspace only**: yes
1142
- **Description**: list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
1213
+ **Description**: list templates for "bit create" and "bit new"
1214
+ list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
1143
1215
 
1144
1216
  `bit templates`
1145
1217
 
@@ -1153,19 +1225,19 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
1153
1225
 
1154
1226
  **Alias**: `at`
1155
1227
  **Workspace only**: yes
1156
- **Description**: test set of components in your workspace
1228
+ **Description**: test components in the workspace
1157
1229
 
1158
- `bit test [pattern]`
1230
+ `bit test [component-pattern]`
1159
1231
 
1160
- | **Option** | **Option alias** | **Description** |
1161
- | -------------------- | :--------------: | -------------------------------------------------------------------- |
1162
- | `--watch` | `-w` | start the tester in watch mode. |
1163
- | `--debug` | `-d` | start the tester in debug mode. |
1164
- | `--all` | `-a` | test all components, not only new and modified |
1165
- | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1166
- | `--coverage` | | show code coverage data |
1167
- | `--env <id>` | `-e` | test only the given env |
1168
- | `--scope <scope>` | `-s` | name of the scope to test |
1232
+ | **Option** | **Option alias** | **Description** |
1233
+ | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1234
+ | `--watch` | `-w` | start the tester in watch mode. |
1235
+ | `--debug` | `-d` | start the tester in debug mode. |
1236
+ | `--all` | `-a` | test all components, not only new and modified |
1237
+ | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1238
+ | `--coverage` | | show code coverage data |
1239
+ | `--env <id>` | `-e` | test only the given env |
1240
+ | `--scope <scope-name>` | `-s` | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
1169
1241
 
1170
1242
  ---
1171
1243
 
@@ -1198,23 +1270,6 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
1198
1270
 
1199
1271
  ---
1200
1272
 
1201
- ## untag
1202
-
1203
- **Workspace only**: yes
1204
- **Description**: revert version(s) tagged for component(s)
1205
- https://bit.dev/docs/components/tags#undoing-a-tag
1206
- you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1207
-
1208
- `bit untag [id] [version]`
1209
-
1210
- | **Option** | **Option alias** | **Description** |
1211
- | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
1212
- | `--all` | `-a` | revert tag for all tagged components |
1213
- | `--soft` | | harmony - revert only soft-tags (components tagged with --soft flag) |
1214
- | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
1215
-
1216
- ---
1217
-
1218
1273
  ## update
1219
1274
 
1220
1275
  **Alias**: `up`
@@ -1232,22 +1287,22 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
1232
1287
  ## use
1233
1288
 
1234
1289
  **Workspace only**: yes
1235
- **Description**: set up aspects in the workspace/scope config
1290
+ **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
1236
1291
 
1237
- `bit use [ids...]`
1292
+ `bit use <component-id>`
1238
1293
 
1239
1294
  ---
1240
1295
 
1241
1296
  ## watch
1242
1297
 
1243
1298
  **Workspace only**: yes
1244
- **Description**: watch a set of components
1299
+ **Description**: automatically recompile modified components (on save)
1245
1300
 
1246
1301
  `bit watch`
1247
1302
 
1248
1303
  | **Option** | **Option alias** | **Description** |
1249
1304
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
1250
- | `--verbose` | `-v` | showing npm verbose output for inspection and prints stack trace |
1305
+ | `--verbose` | `-v` | show npm verbose output for inspection and print the stack trace |
1251
1306
  | `--skip-pre-compilation` | | skip the compilation step before starting to watch |
1252
1307
  | `--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 |
1253
1308