@teambit/harmony.content.cli-reference 1.95.117 → 1.95.119
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.
- package/cli-reference.json +38 -3
- package/cli-reference.mdx +29 -65
- package/dist/cli-reference.json +38 -3
- package/dist/cli-reference.mdx.js +85 -258
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1676321066729.js → preview-1676570198614.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.119.tgz +0 -0
- package/package.json +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.117.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -1345,6 +1345,11 @@
|
|
|
1345
1345
|
"aspect <aspect-id>",
|
|
1346
1346
|
"aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
|
|
1347
1347
|
],
|
|
1348
|
+
[
|
|
1349
|
+
"",
|
|
1350
|
+
"env <env-id>",
|
|
1351
|
+
"env-id of the template"
|
|
1352
|
+
],
|
|
1348
1353
|
[
|
|
1349
1354
|
"d",
|
|
1350
1355
|
"default-scope <scope-name>",
|
|
@@ -2577,7 +2582,7 @@
|
|
|
2577
2582
|
"private": true
|
|
2578
2583
|
},
|
|
2579
2584
|
{
|
|
2580
|
-
"name": "show
|
|
2585
|
+
"name": "show [lane-name]",
|
|
2581
2586
|
"alias": "",
|
|
2582
2587
|
"options": [
|
|
2583
2588
|
[
|
|
@@ -2591,7 +2596,7 @@
|
|
|
2591
2596
|
"show remote lanes"
|
|
2592
2597
|
]
|
|
2593
2598
|
],
|
|
2594
|
-
"description": "show lane details",
|
|
2599
|
+
"description": "show lane details. if no lane specified, show the current lane",
|
|
2595
2600
|
"extendedDescription": "",
|
|
2596
2601
|
"group": "ungrouped",
|
|
2597
2602
|
"private": true,
|
|
@@ -2836,7 +2841,7 @@
|
|
|
2836
2841
|
]
|
|
2837
2842
|
],
|
|
2838
2843
|
"description": "merge a local or a remote lane",
|
|
2839
|
-
"extendedDescription": "
|
|
2844
|
+
"extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
|
|
2840
2845
|
"private": true,
|
|
2841
2846
|
"remoteOp": true,
|
|
2842
2847
|
"arguments": [
|
|
@@ -2998,6 +3003,36 @@
|
|
|
2998
3003
|
}
|
|
2999
3004
|
]
|
|
3000
3005
|
},
|
|
3006
|
+
{
|
|
3007
|
+
"name": "unset <component-pattern> <package...>",
|
|
3008
|
+
"alias": "",
|
|
3009
|
+
"options": [
|
|
3010
|
+
[
|
|
3011
|
+
"d",
|
|
3012
|
+
"dev",
|
|
3013
|
+
"unset from devDependencies"
|
|
3014
|
+
],
|
|
3015
|
+
[
|
|
3016
|
+
"p",
|
|
3017
|
+
"peer",
|
|
3018
|
+
"unset from peerDependencies"
|
|
3019
|
+
]
|
|
3020
|
+
],
|
|
3021
|
+
"description": "unset a dependency to component(s) that was previously set by \"bit deps set\"",
|
|
3022
|
+
"extendedDescription": "",
|
|
3023
|
+
"group": "info",
|
|
3024
|
+
"private": false,
|
|
3025
|
+
"arguments": [
|
|
3026
|
+
{
|
|
3027
|
+
"name": "component-pattern",
|
|
3028
|
+
"description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
|
|
3029
|
+
},
|
|
3030
|
+
{
|
|
3031
|
+
"name": "package...",
|
|
3032
|
+
"description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
|
|
3033
|
+
}
|
|
3034
|
+
]
|
|
3035
|
+
},
|
|
3001
3036
|
{
|
|
3002
3037
|
"name": "debug <component-name>",
|
|
3003
3038
|
"alias": "",
|
package/cli-reference.mdx
CHANGED
|
@@ -1,11 +1,26 @@
|
|
|
1
1
|
# CLI Reference
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Run the following to list all available Bit commands (alternatively, use the `-h` alias, instead of `--help`):
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
bit --help
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Run the following to get help on a specific command:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
bit COMMAND --help
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Run the following to get help on a specific sub-command:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
bit COMMAND SUB_COMMAND --help
|
|
19
|
+
```
|
|
4
20
|
|
|
5
21
|
## add
|
|
6
22
|
|
|
7
23
|
**Alias**: `a`
|
|
8
|
-
**Workspace only**: yes
|
|
9
24
|
**Description**: Add any subset of files to be tracked as a component(s).
|
|
10
25
|
Learn the recommended workflow for tracking directories as components, in the link below.
|
|
11
26
|
|
|
@@ -23,7 +38,6 @@ Learn the recommended workflow for tracking directories as components, in the li
|
|
|
23
38
|
|
|
24
39
|
## app
|
|
25
40
|
|
|
26
|
-
**Workspace only**: yes
|
|
27
41
|
**Description**: Manages apps
|
|
28
42
|
|
|
29
43
|
`bit app <sub-command>`
|
|
@@ -55,7 +69,6 @@ Learn the recommended workflow for tracking directories as components, in the li
|
|
|
55
69
|
|
|
56
70
|
## artifacts
|
|
57
71
|
|
|
58
|
-
**Workspace only**: yes
|
|
59
72
|
**Description**: list and download components artifacts
|
|
60
73
|
artifacts are created on isolated capsules during tag or snap commands.
|
|
61
74
|
example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
|
|
@@ -74,7 +87,6 @@ and a package.tgz file generated by pkg aspect.
|
|
|
74
87
|
|
|
75
88
|
## aspect
|
|
76
89
|
|
|
77
|
-
**Workspace only**: yes
|
|
78
90
|
**Description**: EXPERIMENTAL. manage aspects
|
|
79
91
|
|
|
80
92
|
`bit aspect <sub-command>`
|
|
@@ -126,7 +138,6 @@ and a package.tgz file generated by pkg aspect.
|
|
|
126
138
|
|
|
127
139
|
## build
|
|
128
140
|
|
|
129
|
-
**Workspace only**: yes
|
|
130
141
|
**Description**: run set of tasks for build
|
|
131
142
|
|
|
132
143
|
`bit build [component-pattern]`
|
|
@@ -147,7 +158,6 @@ and a package.tgz file generated by pkg aspect.
|
|
|
147
158
|
|
|
148
159
|
## capsule
|
|
149
160
|
|
|
150
|
-
**Workspace only**: yes
|
|
151
161
|
**Description**: manage capsules
|
|
152
162
|
a capsule is a directory containing the component code, isolated from the workspace.
|
|
153
163
|
normally, capsules are created during the build process, the component files are copied and the packages are installed
|
|
@@ -199,7 +209,6 @@ with no args, only workspace's capsules are deleted
|
|
|
199
209
|
|
|
200
210
|
## check-types
|
|
201
211
|
|
|
202
|
-
**Workspace only**: yes
|
|
203
212
|
**Description**: check typescript types
|
|
204
213
|
|
|
205
214
|
`bit check-types [component-pattern]`
|
|
@@ -214,7 +223,6 @@ with no args, only workspace's capsules are deleted
|
|
|
214
223
|
## checkout
|
|
215
224
|
|
|
216
225
|
**Alias**: `U`
|
|
217
|
-
**Workspace only**: yes
|
|
218
226
|
**Description**: switch between component versions or remove local changes
|
|
219
227
|
|
|
220
228
|
`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
|
|
@@ -243,7 +251,6 @@ with no args, only workspace's capsules are deleted
|
|
|
243
251
|
## clear-cache
|
|
244
252
|
|
|
245
253
|
**Alias**: `cc`
|
|
246
|
-
**Workspace only**: no
|
|
247
254
|
**Description**: clears Bit's cache from current working machine
|
|
248
255
|
The following gets removed by this command:
|
|
249
256
|
|
|
@@ -261,7 +268,6 @@ The following gets removed by this command:
|
|
|
261
268
|
|
|
262
269
|
## cli
|
|
263
270
|
|
|
264
|
-
**Workspace only**: yes
|
|
265
271
|
**Description**: EXPERIMENTAL. enters bit cli program and generates commands list
|
|
266
272
|
|
|
267
273
|
`bit cli`
|
|
@@ -281,7 +287,6 @@ The following gets removed by this command:
|
|
|
281
287
|
|
|
282
288
|
## compile
|
|
283
289
|
|
|
284
|
-
**Workspace only**: yes
|
|
285
290
|
**Description**: compile components in the workspace
|
|
286
291
|
|
|
287
292
|
`bit compile [component-names...]`
|
|
@@ -297,7 +302,6 @@ The following gets removed by this command:
|
|
|
297
302
|
|
|
298
303
|
## completion
|
|
299
304
|
|
|
300
|
-
**Workspace only**: yes
|
|
301
305
|
**Description**: enable bash/zsh-completion shortcuts for commands and options
|
|
302
306
|
|
|
303
307
|
`bit completion`
|
|
@@ -306,7 +310,6 @@ The following gets removed by this command:
|
|
|
306
310
|
|
|
307
311
|
## config
|
|
308
312
|
|
|
309
|
-
**Workspace only**: yes
|
|
310
313
|
**Description**: global config management
|
|
311
314
|
https://bit.dev/docs/config/bit-config
|
|
312
315
|
|
|
@@ -340,7 +343,6 @@ https://bit.dev/docs/config/bit-config
|
|
|
340
343
|
|
|
341
344
|
## create
|
|
342
345
|
|
|
343
|
-
**Workspace only**: yes
|
|
344
346
|
**Description**: create a new component (source files and config) using a template.
|
|
345
347
|
|
|
346
348
|
`bit create <template-name> <component-names...>`
|
|
@@ -357,7 +359,6 @@ https://bit.dev/docs/config/bit-config
|
|
|
357
359
|
|
|
358
360
|
## dependents
|
|
359
361
|
|
|
360
|
-
**Workspace only**: yes
|
|
361
362
|
**Description**: EXPERIMENTAL. show dependents of the given component
|
|
362
363
|
|
|
363
364
|
`bit dependents <component-name>`
|
|
@@ -367,7 +368,6 @@ https://bit.dev/docs/config/bit-config
|
|
|
367
368
|
## deprecate
|
|
368
369
|
|
|
369
370
|
**Alias**: `d`
|
|
370
|
-
**Workspace only**: no
|
|
371
371
|
**Description**: deprecate a component
|
|
372
372
|
|
|
373
373
|
`bit deprecate <component-name>`
|
|
@@ -381,7 +381,6 @@ https://bit.dev/docs/config/bit-config
|
|
|
381
381
|
## deps
|
|
382
382
|
|
|
383
383
|
**Alias**: `dependencies`
|
|
384
|
-
**Workspace only**: yes
|
|
385
384
|
**Description**: manage dependencies
|
|
386
385
|
|
|
387
386
|
`bit deps <sub-command>`
|
|
@@ -407,6 +406,17 @@ https://bit.dev/docs/config/bit-config
|
|
|
407
406
|
| `--dev` | `-d` | remove from devDependencies |
|
|
408
407
|
| `--peer` | `-p` | remove from peerDependencies |
|
|
409
408
|
|
|
409
|
+
### deps unset
|
|
410
|
+
|
|
411
|
+
**Usage**: `deps unset <component-pattern> <package...>`
|
|
412
|
+
|
|
413
|
+
**Description**: unset a dependency to component(s) that was previously set by "bit deps set"
|
|
414
|
+
|
|
415
|
+
| **Option** | **Option alias** | **Description** |
|
|
416
|
+
| ---------- | :--------------: | --------------------------- |
|
|
417
|
+
| `--dev` | `-d` | unset from devDependencies |
|
|
418
|
+
| `--peer` | `-p` | unset from peerDependencies |
|
|
419
|
+
|
|
410
420
|
### deps debug
|
|
411
421
|
|
|
412
422
|
**Usage**: `deps debug <component-name>`
|
|
@@ -446,7 +456,6 @@ https://bit.dev/docs/config/bit-config
|
|
|
446
456
|
|
|
447
457
|
## diff
|
|
448
458
|
|
|
449
|
-
**Workspace only**: yes
|
|
450
459
|
**Description**: show the diff between the components' source files and config
|
|
451
460
|
bit diff => compare all modified components to their model version
|
|
452
461
|
bit diff [ids...] => compare the specified components against their modified states
|
|
@@ -465,7 +474,6 @@ bit diff => compare all modified components to their model version
|
|
|
465
474
|
|
|
466
475
|
## doctor
|
|
467
476
|
|
|
468
|
-
**Workspace only**: yes
|
|
469
477
|
**Description**: diagnose a bit workspace
|
|
470
478
|
|
|
471
479
|
`bit doctor [diagnosis-name]`
|
|
@@ -481,7 +489,6 @@ bit diff => compare all modified components to their model version
|
|
|
481
489
|
## eject
|
|
482
490
|
|
|
483
491
|
**Alias**: `E`
|
|
484
|
-
**Workspace only**: yes
|
|
485
492
|
**Description**: replace components maintained in the workspace with their corresponding packages
|
|
486
493
|
|
|
487
494
|
`bit eject <component-pattern>`
|
|
@@ -496,7 +503,6 @@ bit diff => compare all modified components to their model version
|
|
|
496
503
|
|
|
497
504
|
## eject-conf
|
|
498
505
|
|
|
499
|
-
**Workspace only**: yes
|
|
500
506
|
**Description**: eject components configuration (create a `component.json` file)
|
|
501
507
|
you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
|
|
502
508
|
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
@@ -515,7 +521,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
515
521
|
## envs
|
|
516
522
|
|
|
517
523
|
**Alias**: `env`
|
|
518
|
-
**Workspace only**: yes
|
|
519
524
|
**Description**: list all components maintained by the workspace and their corresponding envs
|
|
520
525
|
|
|
521
526
|
`bit envs`
|
|
@@ -572,7 +577,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
572
577
|
## export
|
|
573
578
|
|
|
574
579
|
**Alias**: `e`
|
|
575
|
-
**Workspace only**: yes
|
|
576
580
|
**Description**: export components from the workspace to remote scopes
|
|
577
581
|
bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well
|
|
578
582
|
`bit export [id...]` => export the given ids to their current scope
|
|
@@ -594,7 +598,6 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
594
598
|
|
|
595
599
|
## fork
|
|
596
600
|
|
|
597
|
-
**Workspace only**: no
|
|
598
601
|
**Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
|
|
599
602
|
|
|
600
603
|
`bit fork <source-component-id> [target-component-name]`
|
|
@@ -612,7 +615,6 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
612
615
|
|
|
613
616
|
## format
|
|
614
617
|
|
|
615
|
-
**Workspace only**: yes
|
|
616
618
|
**Description**: format components in the development workspace
|
|
617
619
|
|
|
618
620
|
`bit format [component...]`
|
|
@@ -627,7 +629,6 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
627
629
|
|
|
628
630
|
## globals
|
|
629
631
|
|
|
630
|
-
**Workspace only**: yes
|
|
631
632
|
**Description**: list all globals
|
|
632
633
|
|
|
633
634
|
`bit globals`
|
|
@@ -640,7 +641,6 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
640
641
|
|
|
641
642
|
## graph
|
|
642
643
|
|
|
643
|
-
**Workspace only**: yes
|
|
644
644
|
**Description**: EXPERIMENTAL. generate an image file with the dependencies graph
|
|
645
645
|
|
|
646
646
|
`bit graph [id]`
|
|
@@ -658,7 +658,6 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
658
658
|
## help
|
|
659
659
|
|
|
660
660
|
**Alias**: `$0`
|
|
661
|
-
**Workspace only**: yes
|
|
662
661
|
**Description**: shows help
|
|
663
662
|
|
|
664
663
|
`bit help`
|
|
@@ -671,7 +670,6 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
671
670
|
|
|
672
671
|
## import
|
|
673
672
|
|
|
674
|
-
**Workspace only**: yes
|
|
675
673
|
**Description**: import components from their remote scopes to the local workspace
|
|
676
674
|
https://bit.dev/docs/components/importing-components
|
|
677
675
|
you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
@@ -699,7 +697,6 @@ you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the
|
|
|
699
697
|
|
|
700
698
|
## init
|
|
701
699
|
|
|
702
|
-
**Workspace only**: no
|
|
703
700
|
**Description**: create or reinitialize an empty workspace
|
|
704
701
|
https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
|
|
705
702
|
|
|
@@ -726,7 +723,6 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
|
|
|
726
723
|
## install
|
|
727
724
|
|
|
728
725
|
**Alias**: `in`
|
|
729
|
-
**Workspace only**: yes
|
|
730
726
|
**Description**: installs workspace dependencies
|
|
731
727
|
when no package is specified, all workspace dependencies are installed and all workspace components are imported.
|
|
732
728
|
|
|
@@ -748,7 +744,6 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
748
744
|
|
|
749
745
|
## link
|
|
750
746
|
|
|
751
|
-
**Workspace only**: yes
|
|
752
747
|
**Description**: create links in the node_modules directory, to core aspects and to components in the workspace
|
|
753
748
|
https://bit.dev/docs/workspace/component-links
|
|
754
749
|
|
|
@@ -766,7 +761,6 @@ https://bit.dev/docs/workspace/component-links
|
|
|
766
761
|
|
|
767
762
|
## lint
|
|
768
763
|
|
|
769
|
-
**Workspace only**: yes
|
|
770
764
|
**Description**: lint components in the development workspace
|
|
771
765
|
|
|
772
766
|
`bit lint [component...]`
|
|
@@ -783,7 +777,6 @@ https://bit.dev/docs/workspace/component-links
|
|
|
783
777
|
## list
|
|
784
778
|
|
|
785
779
|
**Alias**: `ls`
|
|
786
|
-
**Workspace only**: no
|
|
787
780
|
**Description**: list components on a workspace, local scope or a remote scope.
|
|
788
781
|
https://bit.dev/docs/reference/cli-reference#list
|
|
789
782
|
|
|
@@ -801,7 +794,6 @@ https://bit.dev/docs/reference/cli-reference#list
|
|
|
801
794
|
|
|
802
795
|
## log
|
|
803
796
|
|
|
804
|
-
**Workspace only**: no
|
|
805
797
|
**Description**: show components(s) version history
|
|
806
798
|
https://bit.dev/docs/reference/cli-reference#log
|
|
807
799
|
|
|
@@ -818,7 +810,6 @@ https://bit.dev/docs/reference/cli-reference#log
|
|
|
818
810
|
|
|
819
811
|
## log-file
|
|
820
812
|
|
|
821
|
-
**Workspace only**: yes
|
|
822
813
|
**Description**: EXPERIMENTAL. show file history
|
|
823
814
|
|
|
824
815
|
`bit log-file <filepath>`
|
|
@@ -831,7 +822,6 @@ https://bit.dev/docs/reference/cli-reference#log
|
|
|
831
822
|
|
|
832
823
|
## login
|
|
833
824
|
|
|
834
|
-
**Workspace only**: no
|
|
835
825
|
**Description**: log in to Bit cloud
|
|
836
826
|
|
|
837
827
|
`bit login`
|
|
@@ -848,7 +838,6 @@ https://bit.dev/docs/reference/cli-reference#log
|
|
|
848
838
|
|
|
849
839
|
## logout
|
|
850
840
|
|
|
851
|
-
**Workspace only**: yes
|
|
852
841
|
**Description**: log the CLI out of Bit
|
|
853
842
|
|
|
854
843
|
`bit logout`
|
|
@@ -857,7 +846,6 @@ https://bit.dev/docs/reference/cli-reference#log
|
|
|
857
846
|
|
|
858
847
|
## merge
|
|
859
848
|
|
|
860
|
-
**Workspace only**: yes
|
|
861
849
|
**Description**: merge changes of the remote head into local
|
|
862
850
|
merge changes of the remote head into local, optionally use '--abort' or '--resolve
|
|
863
851
|
you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
@@ -882,7 +870,6 @@ you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the
|
|
|
882
870
|
## move
|
|
883
871
|
|
|
884
872
|
**Alias**: `mv`
|
|
885
|
-
**Workspace only**: yes
|
|
886
873
|
**Description**: move a component to a different filesystem path
|
|
887
874
|
move files or directories of component(s)
|
|
888
875
|
https://bit.dev/docs/workspace/moving-components
|
|
@@ -893,7 +880,6 @@ move files or directories of component(s)
|
|
|
893
880
|
|
|
894
881
|
## new
|
|
895
882
|
|
|
896
|
-
**Workspace only**: yes
|
|
897
883
|
**Description**: create a new workspace from a template
|
|
898
884
|
|
|
899
885
|
`bit new <template-name> <workspace-name>`
|
|
@@ -901,6 +887,7 @@ move files or directories of component(s)
|
|
|
901
887
|
| **Option** | **Option alias** | **Description** |
|
|
902
888
|
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
903
889
|
| `--aspect <aspect-id>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
|
|
890
|
+
| `--env <env-id>` | | env-id of the template |
|
|
904
891
|
| `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace.jsonc |
|
|
905
892
|
| `--standalone` | | DEPRECATED. use --skip-git instead |
|
|
906
893
|
| `--skip-git` | `-s` | skip generation of Git repository |
|
|
@@ -911,7 +898,6 @@ move files or directories of component(s)
|
|
|
911
898
|
|
|
912
899
|
## pattern
|
|
913
900
|
|
|
914
|
-
**Workspace only**: yes
|
|
915
901
|
**Description**: list the component ids matching the given pattern
|
|
916
902
|
this command helps validating a pattern before using it in other commands.
|
|
917
903
|
a pattern can be a simple component-id or component-name. e.g. "ui/button".
|
|
@@ -931,7 +917,6 @@ the matching algorithm is done by multimatch (@see https://github.com/sindresorh
|
|
|
931
917
|
|
|
932
918
|
## refactor
|
|
933
919
|
|
|
934
|
-
**Workspace only**: yes
|
|
935
920
|
**Description**: EXPERIMENTAL. source code refactoring / codemod
|
|
936
921
|
|
|
937
922
|
`bit refactor <sub-command>`
|
|
@@ -947,7 +932,6 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
|
|
|
947
932
|
|
|
948
933
|
## remote
|
|
949
934
|
|
|
950
|
-
**Workspace only**: yes
|
|
951
935
|
**Description**: manage set of tracked bit scope(s)
|
|
952
936
|
https://bit.dev/docs/scope/remote-scopes
|
|
953
937
|
|
|
@@ -984,7 +968,6 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
|
|
|
984
968
|
## remove
|
|
985
969
|
|
|
986
970
|
**Alias**: `rm`
|
|
987
|
-
**Workspace only**: no
|
|
988
971
|
**Description**: remove component(s) from the workspace, or a remote scope
|
|
989
972
|
|
|
990
973
|
`bit remove <component-pattern>`
|
|
@@ -1004,7 +987,6 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
|
|
|
1004
987
|
|
|
1005
988
|
## rename
|
|
1006
989
|
|
|
1007
|
-
**Workspace only**: no
|
|
1008
990
|
**Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
|
|
1009
991
|
|
|
1010
992
|
`bit rename <current-name> <new-name>`
|
|
@@ -1019,7 +1001,6 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
|
|
|
1019
1001
|
|
|
1020
1002
|
## reset
|
|
1021
1003
|
|
|
1022
|
-
**Workspace only**: yes
|
|
1023
1004
|
**Description**: revert tagged or snapped versions for component(s)
|
|
1024
1005
|
https://bit.dev/docs/components/tags#undoing-a-tag
|
|
1025
1006
|
|
|
@@ -1037,7 +1018,6 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
1037
1018
|
## run
|
|
1038
1019
|
|
|
1039
1020
|
**Alias**: `c`
|
|
1040
|
-
**Workspace only**: yes
|
|
1041
1021
|
**Description**: run an app (independent of bit's dev server)
|
|
1042
1022
|
|
|
1043
1023
|
`bit run <app-name>`
|
|
@@ -1053,7 +1033,6 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
1053
1033
|
|
|
1054
1034
|
## schema
|
|
1055
1035
|
|
|
1056
|
-
**Workspace only**: yes
|
|
1057
1036
|
**Description**: shows the API schema of a certain component.
|
|
1058
1037
|
you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
|
|
1059
1038
|
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
@@ -1070,7 +1049,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1070
1049
|
|
|
1071
1050
|
## scope
|
|
1072
1051
|
|
|
1073
|
-
**Workspace only**: yes
|
|
1074
1052
|
**Description**: EXPERIMENTAL. manage the scope-name for components
|
|
1075
1053
|
|
|
1076
1054
|
`bit scope <sub-command>`
|
|
@@ -1117,7 +1095,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1117
1095
|
|
|
1118
1096
|
## scope-config
|
|
1119
1097
|
|
|
1120
|
-
**Workspace only**: yes
|
|
1121
1098
|
**Description**: scope config management
|
|
1122
1099
|
|
|
1123
1100
|
`bit scope-config`
|
|
@@ -1150,7 +1127,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1150
1127
|
|
|
1151
1128
|
## show
|
|
1152
1129
|
|
|
1153
|
-
**Workspace only**: yes
|
|
1154
1130
|
**Description**: display the component's essential information
|
|
1155
1131
|
|
|
1156
1132
|
`bit show <component-name>`
|
|
@@ -1166,7 +1142,6 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1166
1142
|
|
|
1167
1143
|
## snap
|
|
1168
1144
|
|
|
1169
|
-
**Workspace only**: yes
|
|
1170
1145
|
**Description**: EXPERIMENTAL. create an immutable and exportable component snapshot (no release version)
|
|
1171
1146
|
https://bit.dev/components/snaps
|
|
1172
1147
|
you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
@@ -1193,7 +1168,6 @@ you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the p
|
|
|
1193
1168
|
## start
|
|
1194
1169
|
|
|
1195
1170
|
**Alias**: `c`
|
|
1196
|
-
**Workspace only**: yes
|
|
1197
1171
|
**Description**: run the ui/development server
|
|
1198
1172
|
|
|
1199
1173
|
`bit start [type] [pattern]`
|
|
@@ -1213,7 +1187,6 @@ you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the p
|
|
|
1213
1187
|
## status
|
|
1214
1188
|
|
|
1215
1189
|
**Alias**: `s`
|
|
1216
|
-
**Workspace only**: yes
|
|
1217
1190
|
**Description**: present the current status of components in the workspace, and notifies when issues are detected
|
|
1218
1191
|
|
|
1219
1192
|
`bit status`
|
|
@@ -1230,7 +1203,6 @@ you can use a pattern for multiple ids, such as bit snap "utils/\*". (wrap the p
|
|
|
1230
1203
|
## tag
|
|
1231
1204
|
|
|
1232
1205
|
**Alias**: `t`
|
|
1233
|
-
**Workspace only**: yes
|
|
1234
1206
|
**Description**: create an immutable and exportable component snapshot, tagged with a release version.
|
|
1235
1207
|
if no patterns are provided, it will tag all new and modified components.
|
|
1236
1208
|
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
|
|
@@ -1270,7 +1242,6 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1270
1242
|
|
|
1271
1243
|
## templates
|
|
1272
1244
|
|
|
1273
|
-
**Workspace only**: yes
|
|
1274
1245
|
**Description**: list templates for "bit create" and "bit new"
|
|
1275
1246
|
list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
|
|
1276
1247
|
|
|
@@ -1286,7 +1257,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1286
1257
|
## test
|
|
1287
1258
|
|
|
1288
1259
|
**Alias**: `at`
|
|
1289
|
-
**Workspace only**: yes
|
|
1290
1260
|
**Description**: test components in the workspace
|
|
1291
1261
|
|
|
1292
1262
|
`bit test [component-pattern]`
|
|
@@ -1305,7 +1275,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1305
1275
|
|
|
1306
1276
|
## undeprecate
|
|
1307
1277
|
|
|
1308
|
-
**Workspace only**: no
|
|
1309
1278
|
**Description**: undeprecate a deprecated component (local/remote)
|
|
1310
1279
|
|
|
1311
1280
|
`bit undeprecate <id>`
|
|
@@ -1315,7 +1284,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1315
1284
|
## uninstall
|
|
1316
1285
|
|
|
1317
1286
|
**Alias**: `un`
|
|
1318
|
-
**Workspace only**: yes
|
|
1319
1287
|
**Description**: uninstall dependencies
|
|
1320
1288
|
|
|
1321
1289
|
`bit uninstall [packages...]`
|
|
@@ -1325,7 +1293,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1325
1293
|
## update
|
|
1326
1294
|
|
|
1327
1295
|
**Alias**: `up`
|
|
1328
|
-
**Workspace only**: yes
|
|
1329
1296
|
**Description**: update dependencies
|
|
1330
1297
|
|
|
1331
1298
|
`bit update`
|
|
@@ -1338,7 +1305,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1338
1305
|
|
|
1339
1306
|
## use
|
|
1340
1307
|
|
|
1341
|
-
**Workspace only**: yes
|
|
1342
1308
|
**Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
|
|
1343
1309
|
|
|
1344
1310
|
`bit use <component-id>`
|
|
@@ -1347,7 +1313,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1347
1313
|
|
|
1348
1314
|
## watch
|
|
1349
1315
|
|
|
1350
|
-
**Workspace only**: yes
|
|
1351
1316
|
**Description**: automatically recompile modified components (on save)
|
|
1352
1317
|
|
|
1353
1318
|
`bit watch`
|
|
@@ -1362,7 +1327,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1362
1327
|
|
|
1363
1328
|
## write-tsconfig
|
|
1364
1329
|
|
|
1365
|
-
**Workspace only**: yes
|
|
1366
1330
|
**Description**: EXPERIMENTAL. write tsconfig.json files in the component directories
|
|
1367
1331
|
|
|
1368
1332
|
`bit write-tsconfig`
|
package/dist/cli-reference.json
CHANGED
|
@@ -1345,6 +1345,11 @@
|
|
|
1345
1345
|
"aspect <aspect-id>",
|
|
1346
1346
|
"aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
|
|
1347
1347
|
],
|
|
1348
|
+
[
|
|
1349
|
+
"",
|
|
1350
|
+
"env <env-id>",
|
|
1351
|
+
"env-id of the template"
|
|
1352
|
+
],
|
|
1348
1353
|
[
|
|
1349
1354
|
"d",
|
|
1350
1355
|
"default-scope <scope-name>",
|
|
@@ -2577,7 +2582,7 @@
|
|
|
2577
2582
|
"private": true
|
|
2578
2583
|
},
|
|
2579
2584
|
{
|
|
2580
|
-
"name": "show
|
|
2585
|
+
"name": "show [lane-name]",
|
|
2581
2586
|
"alias": "",
|
|
2582
2587
|
"options": [
|
|
2583
2588
|
[
|
|
@@ -2591,7 +2596,7 @@
|
|
|
2591
2596
|
"show remote lanes"
|
|
2592
2597
|
]
|
|
2593
2598
|
],
|
|
2594
|
-
"description": "show lane details",
|
|
2599
|
+
"description": "show lane details. if no lane specified, show the current lane",
|
|
2595
2600
|
"extendedDescription": "",
|
|
2596
2601
|
"group": "ungrouped",
|
|
2597
2602
|
"private": true,
|
|
@@ -2836,7 +2841,7 @@
|
|
|
2836
2841
|
]
|
|
2837
2842
|
],
|
|
2838
2843
|
"description": "merge a local or a remote lane",
|
|
2839
|
-
"extendedDescription": "
|
|
2844
|
+
"extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
|
|
2840
2845
|
"private": true,
|
|
2841
2846
|
"remoteOp": true,
|
|
2842
2847
|
"arguments": [
|
|
@@ -2998,6 +3003,36 @@
|
|
|
2998
3003
|
}
|
|
2999
3004
|
]
|
|
3000
3005
|
},
|
|
3006
|
+
{
|
|
3007
|
+
"name": "unset <component-pattern> <package...>",
|
|
3008
|
+
"alias": "",
|
|
3009
|
+
"options": [
|
|
3010
|
+
[
|
|
3011
|
+
"d",
|
|
3012
|
+
"dev",
|
|
3013
|
+
"unset from devDependencies"
|
|
3014
|
+
],
|
|
3015
|
+
[
|
|
3016
|
+
"p",
|
|
3017
|
+
"peer",
|
|
3018
|
+
"unset from peerDependencies"
|
|
3019
|
+
]
|
|
3020
|
+
],
|
|
3021
|
+
"description": "unset a dependency to component(s) that was previously set by \"bit deps set\"",
|
|
3022
|
+
"extendedDescription": "",
|
|
3023
|
+
"group": "info",
|
|
3024
|
+
"private": false,
|
|
3025
|
+
"arguments": [
|
|
3026
|
+
{
|
|
3027
|
+
"name": "component-pattern",
|
|
3028
|
+
"description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
|
|
3029
|
+
},
|
|
3030
|
+
{
|
|
3031
|
+
"name": "package...",
|
|
3032
|
+
"description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
|
|
3033
|
+
}
|
|
3034
|
+
]
|
|
3035
|
+
},
|
|
3001
3036
|
{
|
|
3002
3037
|
"name": "debug <component-name>",
|
|
3003
3038
|
"alias": "",
|